[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-entities\u002Frequisites\u002Flookup":3,"docs-tabs-entities\u002Frequisites\u002Flookup":6},{"content":4,"lastmod":5},"## Look up requisites by number\n\n`POST \u002Fv1\u002Frequisites\u002Flookup`\n\nFinds an organization's requisites by tax ID or a bank's details by bank code in a Bitrix24 external directory and returns fields ready for creating a requisite. The country and the directory are set by the requisite preset in `options.presetId`.\n\n## Request fields (body)\n\n| Field | Type | Required | Description |\n|------|-----|:-----:|---------|\n| `searchQuery` | string | yes | The number to look up. The string must contain 8–12 consecutive digits: tax ID — 10–12 digits, bank code — 9 digits, number in the register of self-regulatory organizations (SRO) — 8 digits |\n| `options.presetId` | number | yes | Requisite preset ID, an integer greater than zero. The preset sets the lookup country. List: [`GET \u002Fv1\u002Frequisite-presets`](\u002Fdocs\u002Fentities\u002Frequisite-presets\u002Flist) |\n| `options.typeId` | string | no | What to look up: `ITIN` — tax ID, `BIC` — bank code, `SRO` — number in the SRO register. The type must match the preset's country, see the table below |\n\nThe body and `options` accept no other fields: an unknown field is rejected with `400 INVALID_PARAMS`.\n\nThe search type depends on the preset's `countryId`. [`GET \u002Fv1\u002Frequisite-presets\u002F:id`](\u002Fdocs\u002Fentities\u002Frequisite-presets\u002Fget) returns the preset's country, and [Requisite preset countries](\u002Fdocs\u002Fentities\u002Frequisite-presets\u002Fcountries) lists the country names.\n\n| Preset `countryId` | Allowed `typeId` | Without `typeId` |\n|---|---|---|\n| `1` | `ITIN`, `BIC` | search by tax ID |\n| `14` | `SRO` | search by SRO number |\n| other countries | do not pass | search without a specific type |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frequisites\u002Flookup\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"searchQuery\": \"1234567890\",\n    \"options\": { \"presetId\": 1 }\n  }'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frequisites\u002Flookup\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"searchQuery\": \"1234567890\",\n    \"options\": { \"presetId\": 1 }\n  }'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frequisites\u002Flookup', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    searchQuery: '1234567890',\n    options: { presetId: 1 },\n  }),\n})\n\nconst { data } = await res.json()\nfor (const item of data) console.log(item.title, item.fields.rqInn)\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Frequisites\u002Flookup', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    searchQuery: '1234567890',\n    options: { presetId: 1 },\n  }),\n})\n\nconst { data } = await res.json()\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|---------|\n| `success` | boolean | `true` on success |\n| `data` | array | Directory records found. An empty array means the directory found nothing |\n| `data[].title` | string | Name of the organization or bank |\n| `data[].subTitle` | string | The number the record was found by, for example `Tax ID 1234567890` |\n| `data[].fields` | object | Requisite fields in camelCase, for example `rqInn`, `rqKpp`, `rqCompanyName`. For a bank — bank detail fields: `rqBik`, `rqCorAccNum`, `rqSwift`. The set depends on the country and the directory. Field schemas: [`GET \u002Fv1\u002Frequisites\u002Ffields`](\u002Fdocs\u002Fentities\u002Frequisites\u002Ffields), [`GET \u002Fv1\u002Fbank-details\u002Ffields`](\u002Fdocs\u002Fentities\u002Fbank-details\u002Ffields) |\n| `data[].fields.presetId` | string | Preset ID suggested by the directory. It may differ from `options.presetId` in the request |\n| `data[].address` | object | Organization addresses. The key is the address type `typeId`, for example `6` — legal address. Absent when the directory returns no address |\n| `data[].address.\u003CtypeId>.fieldCollection` | object | Address parts under numeric codes, for example `50` — postal code, `100` — country, `200` — city, `410` — street and building |\n\n## Response example\n\nOrganization lookup by tax ID with a preset of a country that has a directory, `countryId` `1`:\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"title\": \"Acme LLC\",\n      \"subTitle\": \"Tax ID 1234567890\",\n      \"fields\": {\n        \"rqInn\": \"1234567890\",\n        \"rqKpp\": \"123456789\",\n        \"rqOgrn\": \"1234567890123\",\n        \"rqCompanyName\": \"Acme\",\n        \"rqCompanyFullName\": \"Acme LLC\",\n        \"presetId\": \"1\",\n        \"rqCompanyRegDate\": \"06\u002F20\u002F1991\",\n        \"rqDirector\": \"John Smith\"\n      },\n      \"address\": {\n        \"6\": {\n          \"id\": 0,\n          \"latitude\": \"\",\n          \"longitude\": \"\",\n          \"languageId\": \"en\",\n          \"fieldCollection\": {\n            \"50\": \"10001\",\n            \"100\": \"USA\",\n            \"200\": \"New York\",\n            \"410\": \"1 Main St.\"\n          }\n        }\n      }\n    }\n  ]\n}\n```\n\nBank lookup by bank code, request body `{\"searchQuery\": \"123456789\", \"options\": {\"presetId\": 1, \"typeId\": \"BIC\"}}`:\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"title\": \"Acme Bank\",\n      \"subTitle\": \"Bank code 123456789\",\n      \"fields\": {\n        \"name\": \"Acme Bank\",\n        \"rqBankName\": \"Acme Bank\",\n        \"rqBik\": \"123456789\",\n        \"rqBankAddr\": \"1 Main St., New York, 10001\",\n        \"rqCorAccNum\": \"12345678901234567890\",\n        \"rqSwift\": \"CHASUS33\"\n      }\n    }\n  ]\n}\n```\n\n## Error response example\n\n400 — the search type does not match the preset's country:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INVALID_PARAMS\",\n    \"message\": \"typeId is not supported for this preset country\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `MISSING_REQUIRED_FIELDS` | `options` is missing or `options.presetId` is not an integer greater than zero |\n| 400 | `INVALID_PARAMS` | `searchQuery` does not contain 8–12 consecutive digits, including when `searchQuery` is not passed. Checked before the lookup |\n| 400 | `INVALID_PARAMS` | `options.typeId` is not `ITIN`, `BIC` or `SRO` |\n| 400 | `INVALID_PARAMS` | `options.typeId` does not match the preset's country |\n| 400 | `INVALID_PARAMS` | The number of digits in `searchQuery` does not match the search type, for example 8 digits with `typeId: \"BIC\"` |\n| 400 | `INVALID_PARAMS` | Unknown field in the body or in `options` |\n| 404 | `ENTITY_NOT_FOUND` | No preset with this `options.presetId` |\n| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied CRM access to the key's user |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the lookup. The error text is in `error.message` |\n| 502 | `BITRIX_RESPONSE_INVALID` | Bitrix24 returned a lookup response in an unexpected format |\n| 403 | `SCOPE_DENIED` | The key lacks the `crm` scope |\n| 401 | `TOKEN_MISSING` | The key has no connection to Bitrix24 |\n\nFull list of common API errors — [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n**An empty `data` array does not always mean the organization does not exist.** For a preset of a country without a directory, for example Germany or Kazakhstan, the response is `200` with an empty array and no error. The built-in `Company` and `Person` presets of an international Bitrix24 account have `countryId` `122`: lookup runs for them without a search type and can return an empty array.\n\n**How to create a requisite from the result.** Pass the fields from `data[].fields` to [`POST \u002Fv1\u002Frequisites`](\u002Fdocs\u002Fentities\u002Frequisites\u002Fcreate) together with `entityTypeId`, `entityId`, `name` and the same `presetId` that was in `options.presetId`. Do not take `presetId` from the response: the directory may suggest a different preset. Check the fields against [`GET \u002Fv1\u002Frequisites\u002Ffields`](\u002Fdocs\u002Fentities\u002Frequisites\u002Ffields): the directory may return fields that the preset does not include.\n\n**The address is created separately.** `POST \u002Fv1\u002Frequisites` does not accept an address. Create it with [`POST \u002Fv1\u002Faddresses`](\u002Fdocs\u002Fentities\u002Faddresses\u002Fcreate) using the `typeId` from the `data[].address` key, `entityTypeId: 8` and the `id` of the created requisite.\n\n**A lookup by bank code returns a bank detail.** Create it with [`POST \u002Fv1\u002Fbank-details`](\u002Fdocs\u002Fentities\u002Fbank-details\u002Fcreate) using the fields from `data[].fields` and the `entityId` of the owner requisite.\n\n**A read-only key is accepted.** The lookup writes nothing to the Bitrix24 account.\n\n## See also\n\n- [Create requisite](\u002Fdocs\u002Fentities\u002Frequisites\u002Fcreate)\n- [Requisite fields](\u002Fdocs\u002Fentities\u002Frequisites\u002Ffields)\n- [Create bank detail](\u002Fdocs\u002Fentities\u002Fbank-details\u002Fcreate)\n- [Create address](\u002Fdocs\u002Fentities\u002Faddresses\u002Fcreate)\n- [List requisite presets](\u002Fdocs\u002Fentities\u002Frequisite-presets\u002Flist)\n- [Requisite preset countries](\u002Fdocs\u002Fentities\u002Frequisite-presets\u002Fcountries)\n- [Search CRM records](\u002Fdocs\u002Fentities\u002Fcrm-search\u002Fsearch)\n","2026-10-22",{},1794739413767]