For AI agents: markdown of this page — /docs-content-en/entities/requisites/lookup.md documentation index — /llms.txt

Look up requisite details

POST /v1/requisites/lookup calls crm.requisite.entity.search. A preset is required: Bitrix24 uses it to select the country and external directory.

JSON
{"searchQuery":"1234567890","options":{"presetId":42}}

Use typeId: "BIC" for a supported bank code or typeId: "SRO" for a supported register number. Supported types depend on the preset country. The number must contain 10 to 12 digits for a tax ID, 9 for a bank code or 8 for a register number. A wrong type or format returns 400 before lookup; an unknown preset returns 404. The directory can return an empty list where the Bitrix24 account or country has no organization directory. A Bitrix24 refusal returns 422.

Each data[] entry contains title, subTitle and V1 fields such as rqInn and rqCompanyName. A nested address is returned separately as address, since POST /v1/requisites does not accept it. To create a requisite, combine fields accepted by the selected preset with the required entityTypeId, entityId, name, and the same presetId used for lookup. Do not assume that a preset ID returned by the directory is the one you selected. Create an address separately if needed. For a bank code result, call POST /v1/bank-details with the bank fields and the required owner requisite entityId and name. Availability and the field set depend on the Bitrix24 directory and preset; some cloud versions return fields beyond the preset, so check GET /v1/requisites/fields before creating a record.

Country selection

Preset countries help select a countryId, then a preset for options.presetId.