{"items":[{"type":"link","label":"Overview","link":"/risks-check","routeSlug":"/risks-check","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"risks-check.json","url":"/_bundle/risks-check.json?download"},{"kind":"download","label":"risks-check.yaml","url":"/_bundle/risks-check.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://kycaid.com/terms-and-conditions/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"r","title":"R","lang":"R"},{"key":"ruby","title":"Ruby","lang":"Ruby"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.kycaid.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (1.0)","showPageActions":true}],"sectionId":"/risks-check"}]}]}},{"type":"group","label":"Blacklist databases","link":"/risks-check/blacklist-databases","routeSlug":"/risks-check/blacklist-databases","items":[{"label":"Persons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/blacklist-databases/bdb-persons","routeSlug":"/risks-check/blacklist-databases/bdb-persons","metadata":{"seo":{"title":"Persons","description":"Retrieve information on persons from the Kycaid blacklist databases using fuzzy search to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bdb-persons","name":"Persons","isWebhook":false,"pointer":"/paths/~1bdb~1persons/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Persons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve information on persons from the Kycaid blacklist databases using fuzzy search to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155","pointer":"/paths/~1bdb~1persons/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bdb/persons","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_155"}},"responseCodes":["200","400","402","422","429","500","502"],"pointer":"/bdb/persons","href":"blacklist-databases/bdb-persons","openApiOperationId":"bdb-persons","summary":"Persons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_155"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156"}},"schemaId":"schema_156"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}},"schemaId":"components/schemas/402"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system understands the request but can’t process it due to invalid fields in the request body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that a user has sent too many requests in a given amount of time."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}},"schemaId":"components/schemas/429"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1bdb~1persons/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_156","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_156"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"402","schemaId":"components/schemas/402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}}},{"code":"422","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"429","schemaId":"components/schemas/429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist-databases/bdb-persons"}],"panels":[]}]},"httpPath":"/bdb/persons"},{"label":"Documents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/blacklist-databases/bdb-documents","routeSlug":"/risks-check/blacklist-databases/bdb-documents","metadata":{"seo":{"title":"Documents","description":"Retrieve information on documents from the Kycaid blacklist databases to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bdb-documents","name":"Documents","isWebhook":false,"pointer":"/paths/~1bdb~1documents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve information on documents from the Kycaid blacklist databases to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158","pointer":"/paths/~1bdb~1documents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bdb/documents","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_158"}},"responseCodes":["200","400","402","422","429","500","502"],"pointer":"/bdb/documents","href":"blacklist-databases/bdb-documents","openApiOperationId":"bdb-documents","summary":"Documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bdb--documents--post--200"}},"schemaId":"components/schemas/bdb--documents--post--200"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}},"schemaId":"components/schemas/402"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system understands the request but can’t process it due to invalid fields in the request body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bdb--documents--post--422"}},"schemaId":"components/schemas/bdb--documents--post--422"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that a user has sent too many requests in a given amount of time."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}},"schemaId":"components/schemas/429"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1bdb~1documents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/bdb--documents--post--200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bdb--documents--post--200"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"402","schemaId":"components/schemas/402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}}},{"code":"422","schemaId":"components/schemas/bdb--documents--post--422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/bdb--documents--post--422"}}},{"code":"429","schemaId":"components/schemas/429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist-databases/bdb-documents"}],"panels":[]}]},"httpPath":"/bdb/documents"},{"label":"Tax ID numbers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/blacklist-databases/bdb-tax-ids","routeSlug":"/risks-check/blacklist-databases/bdb-tax-ids","metadata":{"seo":{"title":"Tax ID numbers","description":"Retrieve information on tax ID numbers from the Kycaid blacklist databases to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bdb-tax-ids","name":"Tax ID numbers","isWebhook":false,"pointer":"/paths/~1bdb~1tax-ids/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tax ID numbers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve information on tax ID numbers from the Kycaid blacklist databases to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist"},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159","pointer":"/paths/~1bdb~1tax-ids/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bdb/tax-ids","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_159"}},"responseCodes":["200","400","402","422","429","500","502"],"pointer":"/bdb/tax-ids","href":"blacklist-databases/bdb-tax-ids","openApiOperationId":"bdb-tax-ids","summary":"Tax ID numbers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}},"schemaId":"components/schemas/402"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system understands the request but can’t process it due to invalid fields in the request body."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}},"schemaId":"schema_161"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that a user has sent too many requests in a given amount of time."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}},"schemaId":"components/schemas/429"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1bdb~1tax-ids/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"402","schemaId":"components/schemas/402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}}},{"code":"422","schemaId":"schema_161","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_161"}}},{"code":"429","schemaId":"components/schemas/429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/429"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/blacklist-databases/bdb-tax-ids"}],"panels":[]}]},"httpPath":"/bdb/tax-ids"}],"content":{"contentType":"group","meta":{"name":"Blacklist databases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blacklist databases","showPageActions":true},{"nodeType":"markdoc","content":"Access and query global databases to identify individuals or entities previously flagged for high-risk activities. Use this tool to cross-reference user data against known risk records"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bdb/persons","summary":"Persons","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist-databases/bdb-persons","deprecated":false},{"title":"/bdb/documents","summary":"Documents","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist-databases/bdb-documents","deprecated":false},{"title":"/bdb/tax-ids","summary":"Tax ID numbers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist-databases/bdb-tax-ids","deprecated":false}]}]}]}]}},{"type":"group","label":"Adverse media check","link":"/risks-check/adverse-media-check","routeSlug":"/risks-check/adverse-media-check","items":[{"label":"Adverse media check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/adverse-media-check/amc","routeSlug":"/risks-check/adverse-media-check/amc","metadata":{"seo":{"title":"Adverse media check","description":"The adverse media check screens individuals against news articles. This service may help to identify potential involvement in financial crimes, serious offenses, political exposure, or reputational risks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"amc","name":"Adverse media check","isWebhook":false,"pointer":"/paths/~1services~1amc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adverse media check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The adverse media check screens individuals against news articles. This service may help to identify potential involvement in financial crimes, serious offenses, political exposure, or reputational risks\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"schemaId":"schema_162","pointer":"/paths/~1services~1amc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/amc","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_162"}},"responseCodes":["200","400","402","404","500","502"],"pointer":"/services/amc","href":"adverse-media-check/amc","openApiOperationId":"amc","summary":"Adverse media check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_162","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}},"schemaId":"components/schemas/402"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested resource does not exist or can’t be found in our system."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}},"schemaId":"schema_164"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1services~1amc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"402","schemaId":"components/schemas/402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}}},{"code":"404","schemaId":"schema_164","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adverse-media-check/amc"}],"panels":[]}]},"httpPath":"/services/amc"}],"content":{"contentType":"group","meta":{"name":"Adverse media check"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adverse media check","showPageActions":true},{"nodeType":"markdoc","content":"Search and analyze public sources for negative news or reputational risks associated with an individual. It helps detect potential issues that might not yet be reflected in official government or regulatory databases."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/amc","summary":"Adverse media check","prefix":{"name":"post","color":"post"},"badges":[],"link":"/adverse-media-check/amc","deprecated":false}]}]}]}]}},{"type":"group","label":"Crypto","link":"/risks-check/crypto","routeSlug":"/risks-check/crypto","items":[{"label":"Crypto address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/crypto/crypto-address-verification","routeSlug":"/risks-check/crypto/crypto-address-verification","metadata":{"seo":{"title":"Crypto address","description":"Use this endpoint to screen a cryptocurrency wallet address for AML risk. The system analyzes the address against blockchain analytics data and delivers the result asynchronously to your callback_url as a SERVICE_RESULT callback with service_request_type equal to CRYPTO_ADDRESS_CHECK."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"crypto-address-verification","name":"Crypto address","isWebhook":false,"pointer":"/paths/~1services~1crypto~1address-verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Crypto address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to screen a cryptocurrency wallet address for AML risk. The system analyzes the address against blockchain analytics data and delivers the result asynchronously to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SERVICE_RESULT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_request_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_ADDRESS_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for form-token authentication or test mode requests."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165","pointer":"/paths/~1services~1crypto~1address-verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/crypto/address-verification","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_165"}},"responseCodes":["200","400","403","422","500","502"],"pointer":"/services/crypto/address-verification","href":"crypto/crypto-address-verification","openApiOperationId":"crypto-address-verification","summary":"Crypto address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request is not available for the current authentication method, mode, or plan."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was well-formed but contains invalid or unprocessable data, such as failed validation or incorrect field values."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}},"schemaId":"schema_168"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1services~1crypto~1address-verification/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"403","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}},{"code":"422","schemaId":"schema_168","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/crypto/crypto-address-verification"}],"panels":[]}]},"httpPath":"/services/crypto/address-verification"},{"label":"Crypto transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/crypto/crypto-transaction-verification","routeSlug":"/risks-check/crypto/crypto-transaction-verification","metadata":{"seo":{"title":"Crypto transaction","description":"Use this endpoint to screen a cryptocurrency transaction for AML risk. The system analyzes the transaction against blockchain analytics data and delivers the result asynchronously to your callback_url as a SERVICE_RESULT callback with service_request_type equal to CRYPTO_TRANSACTION_CHECK."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"crypto-transaction-verification","name":"Crypto transaction","isWebhook":false,"pointer":"/paths/~1services~1crypto~1transaction-verification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Crypto transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to screen a cryptocurrency transaction for AML risk. The system analyzes the transaction against blockchain analytics data and delivers the result asynchronously to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SERVICE_RESULT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_request_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CRYPTO_TRANSACTION_CHECK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is not available for form-token authentication or test mode requests."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169"}},"schemaId":"schema_169","pointer":"/paths/~1services~1crypto~1transaction-verification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/crypto/transaction-verification","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_169"}},"responseCodes":["200","400","403","422","500","502"],"pointer":"/services/crypto/transaction-verification","href":"crypto/crypto-transaction-verification","openApiOperationId":"crypto-transaction-verification","summary":"Crypto transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_169","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This request is not available for the current authentication method, mode, or plan."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was well-formed but contains invalid or unprocessable data, such as failed validation or incorrect field values."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}},"schemaId":"schema_170"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1services~1crypto~1transaction-verification/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"403","schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_167"}}},{"code":"422","schemaId":"schema_170","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/crypto/crypto-transaction-verification"}],"panels":[]}]},"httpPath":"/services/crypto/transaction-verification"}],"content":{"contentType":"group","meta":{"name":"Crypto"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Crypto","showPageActions":true},{"nodeType":"markdoc","content":"Verify the risk profile of cryptocurrency addresses. Detect links to illicit wallets, mixing services, or high-risk exchanges to ensure the safety of digital asset transfers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/crypto/address-verification","summary":"Crypto address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/crypto/crypto-address-verification","deprecated":false},{"title":"/services/crypto/transaction-verification","summary":"Crypto transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/crypto/crypto-transaction-verification","deprecated":false}]}]}]}]}},{"type":"group","label":"Phone numbers","link":"/risks-check/phone-numbers","routeSlug":"/risks-check/phone-numbers","items":[{"label":"Send SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/phone-numbers/phone-number-send-sms","routeSlug":"/risks-check/phone-numbers/phone-number-send-sms","metadata":{"seo":{"title":"Send SMS","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"phone-number-send-sms","name":"Send SMS","isWebhook":false,"pointer":"/paths/~1services~1phone-number~1check~1request/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#phone-number-check"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/phone-number/check/request","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/phone-number/check/request","href":"phone-numbers/phone-number-send-sms","openApiOperationId":"phone-number-send-sms","summary":"Send SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-numbers/phone-number-send-sms"}],"panels":[]}]},"httpPath":"/services/phone-number/check/request"},{"label":"Send PIN code from SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/phone-numbers/phone-number-send-pin-code","routeSlug":"/risks-check/phone-numbers/phone-number-send-pin-code","metadata":{"seo":{"title":"Send PIN code from SMS","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"phone-number-send-pin-code","name":"Send PIN code from SMS","isWebhook":false,"pointer":"/paths/~1services~1phone-number~1check~1submit-pin-code/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send PIN code from SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#phone-number-check"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/phone-number/check/submit-pin-code","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/phone-number/check/submit-pin-code","href":"phone-numbers/phone-number-send-pin-code","openApiOperationId":"phone-number-send-pin-code","summary":"Send PIN code from SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phone-numbers/phone-number-send-pin-code"}],"panels":[]}]},"httpPath":"/services/phone-number/check/submit-pin-code"}],"content":{"contentType":"group","meta":{"name":"Phone numbers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone numbers","showPageActions":true},{"nodeType":"markdoc","content":"Validate phone numbers and assess their technical risk level. Identify virtual numbers (VOIP), disposable SIMs, and ecarrier-specific data to flag potential fraudulent activity."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/phone-number/check/request","summary":"Send SMS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone-numbers/phone-number-send-sms","deprecated":false},{"title":"/services/phone-number/check/submit-pin-code","summary":"Send PIN code from SMS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone-numbers/phone-number-send-pin-code","deprecated":false}]}]}]}]}},{"type":"group","label":"Transaction monitoring","link":"/risks-check/transaction-monitoring","routeSlug":"/risks-check/transaction-monitoring","items":[{"label":"Submit transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/transaction-monitoring/submit-transaction","routeSlug":"/risks-check/transaction-monitoring/submit-transaction","metadata":{"seo":{"title":"Submit transaction","description":"Use this endpoint to submit transaction data for screening and monitoring. The system analyzes the payment parameters against your selected ruleset_id and delivers the result asynchronously to your callback_url. To identify the customer, you must provide either an internal applicant_id or your external_applicant_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submit-transaction","name":"Submit transaction","isWebhook":false,"pointer":"/paths/~1services~1transaction-monitoring/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to submit transaction data for screening and monitoring. The system analyzes the payment parameters against your selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleset_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and delivers the result asynchronously to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callback_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To identify the customer, you must provide either an internal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_applicant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171","pointer":"/paths/~1services~1transaction-monitoring/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/transaction-monitoring","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_171"}},"responseCodes":["200","400","402","422","500","502"],"pointer":"/services/transaction-monitoring","href":"transaction-monitoring/submit-transaction","openApiOperationId":"submit-transaction","summary":"Submit transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_171"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was successful, and our system returned an expected response."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}},"schemaId":"schema_172"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Our system could not process the request due to invalid syntax, missing parameters, or incorrect data format. Check the request structure and try again."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}},"schemaId":"components/schemas/400"},{"code":"402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Required"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access to the requested resource is restricted until a payment is successfully processed. Ensure your account has a valid payment method or sufficient funds to complete this action."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}},"schemaId":"components/schemas/402"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Content"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was well-formed but contains invalid or unprocessable data, such as failed validation or incorrect field values."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}},"schemaId":"schema_173"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system encountered an unexpected condition that prevented it from fulfilling the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}},"schemaId":"components/schemas/500"},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Gateway"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response indicates that our system is unable to reach or communicate properly with an upstream server it relies on, the URL provided is incorrect, or a required token is missing from the request."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}},"schemaId":"components/schemas/502"}],"pointer":"/paths/~1services~1transaction-monitoring/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_172","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}}},{"code":"400","schemaId":"components/schemas/400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/400"}}},{"code":"402","schemaId":"components/schemas/402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/402"}}},{"code":"422","schemaId":"schema_173","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_173"}}},{"code":"500","schemaId":"components/schemas/500","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/500"}}},{"code":"502","schemaId":"components/schemas/502","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/502"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transaction-monitoring/submit-transaction"}],"panels":[]}]},"httpPath":"/services/transaction-monitoring"}],"content":{"contentType":"group","meta":{"name":"Transaction monitoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction monitoring","showPageActions":true},{"nodeType":"markdoc","content":"Transaction monitoring allows real-time analysis of financial operations based on your custom risk logic. Use this tool to evaluate payment parameters, such as directions and amounts, to automate decision-making and identify potentially suspicious activities."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/transaction-monitoring","summary":"Submit transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transaction-monitoring/submit-transaction","deprecated":false}]}]}]}]}},{"type":"group","label":"QES","link":"/risks-check/qes","routeSlug":"/risks-check/qes","items":[{"label":"SmartID • Start","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/qes/qes-smartid-start","routeSlug":"/risks-check/qes/qes-smartid-start","metadata":{"seo":{"title":"SmartID • Start","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"qes-smartid-start","name":"SmartID • Start","isWebhook":false,"pointer":"/paths/~1services~1ua~1smartid~1start/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SmartID • Start","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#qes-smart-id"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/ua/smartid/start","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/ua/smartid/start","href":"qes/qes-smartid-start","openApiOperationId":"qes-smartid-start","summary":"SmartID • Start"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qes/qes-smartid-start"}],"panels":[]}]},"httpPath":"/services/ua/smartid/start"},{"label":"SmartID • Get status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/qes/qes-smartid-get-status","routeSlug":"/risks-check/qes/qes-smartid-get-status","metadata":{"seo":{"title":"SmartID • Get status","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"qes-smartid-get-status","name":"SmartID • Get status","isWebhook":false,"pointer":"/paths/~1services~1ua~1smartid~1status/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SmartID • Get status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#qes-smart-id"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/ua/smartid/status","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/ua/smartid/status","href":"qes/qes-smartid-get-status","openApiOperationId":"qes-smartid-get-status","summary":"SmartID • Get status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qes/qes-smartid-get-status"}],"panels":[]}]},"httpPath":"/services/ua/smartid/status"},{"label":"Diia.Signature • Start","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/qes/qes-diia-signature-start","routeSlug":"/risks-check/qes/qes-diia-signature-start","metadata":{"seo":{"title":"Diia.Signature • Start","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"qes-diia-signature-start","name":"Diia.Signature • Start","isWebhook":false,"pointer":"/paths/~1services~1ua~1diia-signature~1start/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Diia.Signature • Start","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#qes-diia-signature"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/ua/diia-signature/start","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/ua/diia-signature/start","href":"qes/qes-diia-signature-start","openApiOperationId":"qes-diia-signature-start","summary":"Diia.Signature • Start"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qes/qes-diia-signature-start"}],"panels":[]}]},"httpPath":"/services/ua/diia-signature/start"},{"label":"Diia.Signature • Get status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/risks-check/qes/qes-diia-signature-get-status","routeSlug":"/risks-check/qes/qes-diia-signature-get-status","metadata":{"seo":{"title":"Diia.Signature • Get status","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"qes-diia-signature-get-status","name":"Diia.Signature • Get status","isWebhook":false,"pointer":"/paths/~1services~1ua~1diia-signature~1status/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Diia.Signature • Get status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Content migration in progress"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs-v1.kycaid.com/#qes-diia-signature"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy documentation"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this article"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/ua/diia-signature/status","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/ua/diia-signature/status","href":"qes/qes-diia-signature-get-status","openApiOperationId":"qes-diia-signature-get-status","summary":"Diia.Signature • Get status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/qes/qes-diia-signature-get-status"}],"panels":[]}]},"httpPath":"/services/ua/diia-signature/status"}],"content":{"contentType":"group","meta":{"name":"QES"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"QES","showPageActions":true},{"nodeType":"markdoc","content":"Verify Qualified Electronic Signatures (QES) to confirm the authenticity and legal integrity of digitally signed documents."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/ua/smartid/start","summary":"SmartID • Start","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qes/qes-smartid-start","deprecated":false},{"title":"/services/ua/smartid/status","summary":"SmartID • Get status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qes/qes-smartid-get-status","deprecated":false},{"title":"/services/ua/diia-signature/start","summary":"Diia.Signature • Start","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qes/qes-diia-signature-start","deprecated":false},{"title":"/services/ua/diia-signature/status","summary":"Diia.Signature • Get status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/qes/qes-diia-signature-get-status","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/400":{"id":"components/schemas/400","kind":"json-schema","title":"400","data":{"type":"object","properties":{"type":{"type":"string","example":"bad_request"},"errors":{"type":"array"}}}},"components/schemas/402":{"id":"components/schemas/402","kind":"json-schema","title":"402","data":{"type":"object","properties":{"type":{"type":"string","example":"insufficient_funds"},"errors":{"type":"array"}}}},"components/schemas/429":{"id":"components/schemas/429","kind":"json-schema","title":"429","data":{"type":"object","properties":{"type":{"type":"string","example":"flow"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"limit_exceeded"},"message":{"type":"string","example":"Rate limit exceeded"}}}}}}},"components/schemas/500":{"id":"components/schemas/500","kind":"json-schema","title":"500","data":{"type":"object","properties":{"type":{"type":"string","example":"internal_server"},"errors":{"type":"array"}}}},"components/schemas/502":{"id":"components/schemas/502","kind":"json-schema","title":"502","data":{"type":"string","example":"<!doctype html><meta charset='utf-8'><meta name=viewport content='width=device-width, initial-scale=1'><title>502</title>502 Bad Gateway"}},"components/schemas/full_name":{"id":"components/schemas/full_name","kind":"json-schema","title":"full_name","data":{"type":["string","null"],"format":"name","pattern":"^[a-zA-Z ,.''-]{1,100}$","minLength":2,"maxLength":100,"example":"Josh Coffey","description":"The full name of a person, which includes a first and last name"}},"components/schemas/first_name":{"id":"components/schemas/first_name","kind":"json-schema","title":"First name","data":{"title":"First name","type":["string","null"],"format":"name","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z ,.''-]{2,64}$","example":"Josh","description":"The first name of a person"}},"components/schemas/last_name":{"id":"components/schemas/last_name","kind":"json-schema","title":"Last name","data":{"title":"Last name","type":["string","null"],"format":"name","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z ,.''-]{2,64}$","example":"Coffey","description":"The last name of a person"}},"components/schemas/middle_name":{"id":"components/schemas/middle_name","kind":"json-schema","title":"Middle name","data":{"title":"Middle name","type":["string","null"],"format":"name","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z ,.''-]{1,64}$","example":"David","description":"The middle name of a person"}},"components/schemas/dob":{"id":"components/schemas/dob","kind":"json-schema","title":"dob","data":{"type":["string","null"],"format":"date","example":"1976-02-21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601"},"children":[]}]}]}]}},"components/schemas/residence_country":{"id":"components/schemas/residence_country","kind":"json-schema","title":"residence_country","data":{"type":["string","null"],"minLength":2,"maxLength":2,"example":"GB","description":"A residence country of an object. A two-letter country code according to ISO 3166-2"}},"components/schemas/gender":{"id":"components/schemas/gender","kind":"json-schema","title":"gender","data":{"type":["string","null"],"enum":["M","F"],"example":"M","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The gender of a person. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates male; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates female"},"children":[]}]}]}]}},"components/schemas/name_match_threshold":{"id":"components/schemas/name_match_threshold","kind":"json-schema","title":"Name match threshold","data":{"title":"Name match threshold","type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.75,"description":"The minimum similarity score required to include a name in the search results. A higher value returns fewer, more exact matches, and a lower value returns more results with less similarity"}},"components/schemas/name_match_weight":{"id":"components/schemas/name_match_weight","kind":"json-schema","title":"name_match_weight","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.7,"description":"Influence of a name match on the total match score"}},"components/schemas/dob_match_enabled":{"id":"components/schemas/dob_match_enabled","kind":"json-schema","title":"dob_match_enabled","data":{"type":"boolean","enum":[true,false],"example":true,"description":"Enable or disable inclusion of a date of birth in the total match score"}},"components/schemas/dob_match_weight":{"id":"components/schemas/dob_match_weight","kind":"json-schema","title":"dob_match_weight","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.1,"description":"Influence of a date of birth match on the total match score"}},"components/schemas/residence_country_match_enabled":{"id":"components/schemas/residence_country_match_enabled","kind":"json-schema","title":"residence_country_match_enabled","data":{"type":"boolean","enum":[true,false],"example":true,"description":"Enable or disable inclusion of a residence country match in the total match score"}},"components/schemas/residence_country_match_weight":{"id":"components/schemas/residence_country_match_weight","kind":"json-schema","title":"residence_country_match_weight","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.05,"description":"Influence of a residence country match on the total match score"}},"components/schemas/gender_match_enabled":{"id":"components/schemas/gender_match_enabled","kind":"json-schema","title":"gender_match_enabled","data":{"type":"boolean","enum":[true,false],"example":true,"description":"Enable or disable inclusion of a gender match in the total match score"}},"components/schemas/gender_match_weight":{"id":"components/schemas/gender_match_weight","kind":"json-schema","title":"gender_match_weight","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.05,"description":"Influence of a gender match on the total match score"}},"components/schemas/bdb_type":{"id":"components/schemas/bdb_type","kind":"json-schema","title":"bdb_type","data":{"type":"array","items":{"type":"string","enum":["INTERNAL","SANCTIONS","PEP","WANTED","EXPIRED"]},"example":["SANCTIONS"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A type of blacklist databases to make a check"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SANCTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Global and local sanctions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"databases"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PEP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Databases of politically exposed persons (PEP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WANTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Databases of persons being searched for by the police"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Databases of stolen or lost documents"},"children":[]}]}]}]}]}},"components/schemas/origin_full_name":{"id":"components/schemas/origin_full_name","kind":"json-schema","title":"origin_full_name","data":{"type":["string","null"],"format":"name","minLength":1,"maxLength":100,"example":"Джош Кофі","description":"A full name of an object, which consists of a first name and a last name, set in a native language"}},"components/schemas/origin_first_name":{"id":"components/schemas/origin_first_name","kind":"json-schema","title":"origin_first_name","data":{"type":["string","null"],"format":"name","minLength":1,"maxLength":64,"example":"Джош","description":"A first name of an object, set in a native language"}},"components/schemas/origin_last_name":{"id":"components/schemas/origin_last_name","kind":"json-schema","title":"origin_last_name","data":{"type":["string","null"],"format":"name","minLength":1,"maxLength":64,"example":"Кофі","description":"A last name of an entity, set in a native language"}},"components/schemas/origin_middle_name":{"id":"components/schemas/origin_middle_name","kind":"json-schema","title":"origin_middle_name","data":{"type":["string","null"],"format":"name","minLength":1,"maxLength":64,"pattern":"^[a-zA-Z ,.''-]{1,64}$","example":"Conrad","description":"A middle name of an object, set in a native language"}},"components/schemas/description":{"id":"components/schemas/description","kind":"json-schema","title":"description","data":{"type":["string","null"],"minLength":1,"maxLength":2048,"example":"Reciprocal - 2010-04-30","description":"The detailed description of a status in blacklist databases"}},"components/schemas/bdb_name":{"id":"components/schemas/bdb_name","kind":"json-schema","title":"bdb_name","data":{"type":["string","null"],"minLength":2,"maxLength":255,"example":"Open Sanctions Default","description":"A name of a blacklist database"}},"components/schemas/name_match_score":{"id":"components/schemas/name_match_score","kind":"json-schema","title":"name_match_score","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.8,"description":"Relevance of a name match in a fuzzy search"}},"components/schemas/total_match_score":{"id":"components/schemas/total_match_score","kind":"json-schema","title":"total_match_score","data":{"type":"number","format":"float","minimum":0,"maximum":1,"multipleOf":0.01,"example":0.86,"description":"The calculated relevance score for a search result"}},"components/schemas/document_number--bdb--documents":{"id":"components/schemas/document_number--bdb--documents","kind":"json-schema","title":"document_number--bdb--documents","data":{"type":"string","minLength":2,"maxLength":32,"example":"920927302325","description":"A number of a document to check with blacklist databases"}},"components/schemas/document_type":{"id":"components/schemas/document_type","kind":"json-schema","title":"document_type","data":{"type":"string","enum":["PASSPORT","DOMESTIC_PASSPORT","GOVERNMENT_ID","DRIVERS_LICENSE","FOREIGN_CITIZEN_PASSPORT","PERMANENT_RESIDENCE_PERMIT","REFUGEE_CARD"],"example":"PASSPORT","description":"A type of a document"}},"components/schemas/document_country":{"id":"components/schemas/document_country","kind":"json-schema","title":"document_country","data":{"type":["string","null"],"minLength":2,"maxLength":2,"example":"GB","description":"An issuing country of a document. A two-letter country code according to ISO 3166-2"}},"components/schemas/bdb--documents--post--200":{"id":"components/schemas/bdb--documents--post--200","kind":"json-schema","title":"bdb--documents--post--200","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"document_number":{"$ref":"#/components/schemas/document_number--bdb--documents"},"document_type":{"$ref":"#/components/schemas/document_type"},"document_country":{"$ref":"#/components/schemas/document_country"},"description":{"$ref":"#/components/schemas/description"},"bdb_name":{"$ref":"#/components/schemas/bdb_name"},"bdb_type":{"$ref":"#/components/schemas/bdb_type"}}}}}}},"components/schemas/bdb--documents--post--422":{"id":"components/schemas/bdb--documents--post--422","kind":"json-schema","title":"bdb--documents--post--422","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"document_number"},"message":{"type":"string","example":"document_number must have from 2 to 32 characters and only letters and numbers"}}}}}}},"components/schemas/tax_id_number":{"id":"components/schemas/tax_id_number","kind":"json-schema","title":"tax_id_number","data":{"type":"string","minLength":2,"maxLength":32,"example":"1129821775","description":"A tax identification number"}},"components/schemas/tax_id_country":{"id":"components/schemas/tax_id_country","kind":"json-schema","title":"tax_id_country","data":{"type":["string","null"],"minLength":2,"maxLength":2,"example":"GB","description":"An issuing country of a tax identification number. A two-letter country code according to ISO 3166-2"}},"components/schemas/accuracy":{"id":"components/schemas/accuracy","kind":"json-schema","title":"accuracy","data":{"type":"integer","minimum":50,"maximum":100,"example":75,"description":"An accuracy of provided information (in percents)"}},"components/schemas/bdb--tax-ids--200":{"id":"components/schemas/bdb--tax-ids--200","kind":"json-schema","title":"bdb--tax-ids--200","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"full_name":{"$ref":"#/components/schemas/full_name"},"origin_full_name":{"$ref":"#/components/schemas/origin_full_name"},"first_name":{"$ref":"#/components/schemas/first_name"},"origin_first_name":{"$ref":"#/components/schemas/origin_first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"origin_last_name":{"$ref":"#/components/schemas/origin_last_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"origin_middle_name":{"$ref":"#/components/schemas/origin_middle_name"},"residence_country":{"$ref":"#/components/schemas/residence_country"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"},"description":{"$ref":"#/components/schemas/description"},"bdb_name":{"$ref":"#/components/schemas/bdb_name"},"bdb_type":{"$ref":"#/components/schemas/bdb_type"},"accuracy":{"$ref":"#/components/schemas/accuracy"}}}}}}},"components/schemas/bdb--tax-ids--200--not_found":{"id":"components/schemas/bdb--tax-ids--200--not_found","kind":"json-schema","title":"Tax ID was not found","data":{"title":"Tax ID was not found","type":"object","properties":{"data":{"type":"array"}}}},"components/schemas/bdb--tax-ids--422--bdb_types":{"id":"components/schemas/bdb--tax-ids--422--bdb_types","kind":"json-schema","title":"Blacklist database name is invalid","data":{"title":"Blacklist database name is invalid","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"bdb_types"},"message":{"type":"string","example":"Type of blacklist databases is not valid"}}}}}}},"components/schemas/bdb--tax-ids--422--tax_id_country":{"id":"components/schemas/bdb--tax-ids--422--tax_id_country","kind":"json-schema","title":"Issuing country of a tax identification number is invalid","data":{"title":"Issuing country of a tax identification number is invalid","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"tax_id_country"},"message":{"type":"string","example":"tax_id_country is required and must have 2 characters"}}}},"data":{"type":"array"}}}},"components/schemas/primary_keywords":{"id":"components/schemas/primary_keywords","kind":"json-schema","title":"Primary keywords","data":{"title":"Primary keywords","type":"array","minLength":1,"maxLength":32,"pattern":"^[a-zA-Z0-9 -'`’]{1,32}$","example":["corruption","money laundering","murder"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of primary keywords. Articles must contain at least one of these keywords to be considered relevant to the search. A maximum of 20 primary keywords are permitted (including predefined keywords for individuals’s first name and last name)"},"children":[]}]}]}]}},"components/schemas/secondary_keywords":{"id":"components/schemas/secondary_keywords","kind":"json-schema","title":"Secondary keywords","data":{"title":"Secondary keywords","type":"array","minLength":1,"maxLength":32,"pattern":"^[a-zA-Z0-9 -'`’]{1,32}$","example":["sanctioned","whistleblower","conviction"],"description":"A list of optional secondary keywords. Articles containing these keywords may see improved search result ranking. A maximum of 20 secondary keywords are permitted"}},"components/schemas/callback_url":{"id":"components/schemas/callback_url","kind":"json-schema","title":"Callback URL","data":{"title":"Callback URL","type":"string","format":"uri","maxLength":2048,"example":"https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03","description":"The endpoint URL where our system will send real-time webhook notifications via POST request. Your server should respond with a 200 OK status to acknowledge receipt"}},"components/schemas/hash":{"id":"components/schemas/hash","kind":"json-schema","title":"hash","data":{"type":"string","minLength":16,"maxLength":128,"example":"1adebf1ade1bfad1ebf1adeb1fade1bfad1e","description":"The cryptocurrency wallet address to be checked."}},"components/schemas/asset":{"id":"components/schemas/asset","kind":"json-schema","title":"asset","data":{"type":"string","enum":["BTC","BCH","LTC","XRP","ETC","ADA","ETH","TRX","ALGO","XLM","MATIC","ZEC","DOGE","SOL","BSV","AVAX","ARB","DOT","TetherOMNI","TON","XTZ","NEAR"],"example":"BTC","description":"The asset ticker of the checked address."}},"components/schemas/crypto--address":{"id":"components/schemas/crypto--address","kind":"json-schema","title":"crypto--address","data":{"type":"string","minLength":16,"maxLength":128,"example":"1adebf1ade1bfad1ebf1adeb1fade1bfad1e","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cryptocurrency wallet address related to the transaction. Whether this address is the sender or the recipient depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/direction--crypto":{"id":"components/schemas/direction--crypto","kind":"json-schema","title":"direction--crypto","data":{"type":"string","enum":["deposit","withdrawal"],"example":"withdrawal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The direction of the transaction relative to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — funds are being received at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the counterparty is the sender being screened)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"withdrawal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — funds are being sent from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the counterparty is the recipient being screened)."},"children":[]}]}]}]}]}},"components/schemas/applicant_id":{"id":"components/schemas/applicant_id","kind":"json-schema","title":"Applicant ID","data":{"title":"Applicant ID","type":"string","minLength":36,"maxLength":36,"example":"da0ebf0ade0bfad0ebf0adeb0fade0bfad0e","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request"},"children":[]}]}]}]}},"components/schemas/external_applicant_id":{"id":"components/schemas/external_applicant_id","kind":"json-schema","title":"External applicant ID","data":{"title":"External applicant ID","type":["string","null"],"minLength":0,"maxLength":50,"example":"ad0ebf0a-de0b-fad0-ebf0-adeb0fade0bf","description":"A unique identifier of your user in your system"}},"components/schemas/external_applicant_registered_at":{"id":"components/schemas/external_applicant_registered_at","kind":"json-schema","title":"External applicant registration date and time","data":{"title":"External applicant registration date and time","type":"string","minLength":19,"maxLength":19,"example":"2025-12-19 18:44:08","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time of user registration in the customer's system. Must be in UTC and follow the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Cannot be a future date"},"children":[]}]}]}]}},"components/schemas/transaction_monitoring_direction":{"id":"components/schemas/transaction_monitoring_direction","kind":"json-schema","title":"Transaction direction","data":{"title":"Transaction direction","type":"string","enum":["incoming","outgoing"],"example":"incoming","description":"Direction of the transaction (relative to user's account). Value must be in lowercase"}},"components/schemas/transaction_monitoring_amount":{"id":"components/schemas/transaction_monitoring_amount","kind":"json-schema","title":"Transaction amount","data":{"title":"Transaction amount","type":"string","format":"number","pattern":"^\\d+(\\.\\d+)?$","example":"16.003892000000000000","description":"Exact amount of the transaction stored as decimal(36,18). Must be sent as a string to preserve 18-decimal precision and prevent floating-point errors"}},"components/schemas/transaction_monitoring_asset":{"id":"components/schemas/transaction_monitoring_asset","kind":"json-schema","title":"Transaction asset","data":{"title":"Transaction asset","type":"string","maxLength":10,"example":"GBP","description":"Ticker symbol of the asset. Use ISO 4217 for fiat (e.g., USD) or common ticker symbols for crypto (e.g., BTC, USDT, stETH)"}},"components/schemas/transaction_monitoring_created_at":{"id":"components/schemas/transaction_monitoring_created_at","kind":"json-schema","title":"Transaction creation time","data":{"title":"Transaction creation time","type":"string","minLength":19,"maxLength":19,"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","example":"2026-02-01 15:27:15","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date and time when the transaction was created in the customer's system. Must be in UTC and follow the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD hh:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Cannot be a future date"},"children":[]}]}]}]}},"components/schemas/ruleset_id":{"id":"components/schemas/ruleset_id","kind":"json-schema","title":"Ruleset ID","data":{"title":"Ruleset ID","type":"string","minLength":36,"maxLength":36,"pattern":"^[a-fA-F0-9]{36}$","example":"da0ebf0ade0bfad0ebf0adeb0fade0bfad0e","description":"The unique 36-character hexadecimal identifier of the screening ruleset. This ID is automatically generated after you create a ruleset in the Dashboard. It determines which ruleset will be applied to the transaction"}},"schema_155":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Search by a full name","properties":{"full_name":{"$ref":"#/components/schemas/full_name"},"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"dob":{"$ref":"#/components/schemas/dob"},"residence_country":{"$ref":"#/components/schemas/residence_country"},"gender":{"$ref":"#/components/schemas/gender"},"name_match_threshold":{"$ref":"#/components/schemas/name_match_threshold"},"name_match_weight":{"$ref":"#/components/schemas/name_match_weight"},"dob_match_enabled":{"$ref":"#/components/schemas/dob_match_enabled"},"dob_match_weight":{"$ref":"#/components/schemas/dob_match_weight"},"residence_country_match_enabled":{"$ref":"#/components/schemas/residence_country_match_enabled"},"residence_country_match_weight":{"$ref":"#/components/schemas/residence_country_match_weight"},"gender_match_enabled":{"$ref":"#/components/schemas/gender_match_enabled"},"gender_match_weight":{"$ref":"#/components/schemas/gender_match_weight"},"bdb_types":{"$ref":"#/components/schemas/bdb_type"}},"required":["full_name"]},{"type":"object","title":"Search by a first name and a last name","properties":{"full_name":{"$ref":"#/components/schemas/full_name"},"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"dob":{"$ref":"#/components/schemas/dob"},"residence_country":{"$ref":"#/components/schemas/residence_country"},"gender":{"$ref":"#/components/schemas/gender"},"name_match_threshold":{"$ref":"#/components/schemas/name_match_threshold"},"name_match_weight":{"$ref":"#/components/schemas/name_match_weight"},"dob_match_enabled":{"$ref":"#/components/schemas/dob_match_enabled"},"dob_match_weight":{"$ref":"#/components/schemas/dob_match_weight"},"residence_country_match_enabled":{"$ref":"#/components/schemas/residence_country_match_enabled"},"residence_country_match_weight":{"$ref":"#/components/schemas/residence_country_match_weight"},"gender_match_enabled":{"$ref":"#/components/schemas/gender_match_enabled"},"gender_match_weight":{"$ref":"#/components/schemas/gender_match_weight"},"bdb_types":{"$ref":"#/components/schemas/bdb_type"}},"required":["first_name","last_name"]}]},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"parameters":{"type":"object","properties":{"name_match_threshold":{"$ref":"#/components/schemas/name_match_threshold"},"name_match_weight":{"$ref":"#/components/schemas/name_match_weight"},"dob_match_enabled":{"$ref":"#/components/schemas/dob_match_enabled"},"dob_match_weight":{"$ref":"#/components/schemas/dob_match_weight"},"residence_country_match_enabled":{"$ref":"#/components/schemas/residence_country_match_enabled"},"residence_country_match_weight":{"$ref":"#/components/schemas/residence_country_match_weight"},"gender_match_enabled":{"$ref":"#/components/schemas/gender_match_enabled"},"gender_match_weight":{"$ref":"#/components/schemas/gender_match_weight"}}},"result":{"type":"array","items":{"type":"object","properties":{"full_name":{"$ref":"#/components/schemas/full_name"},"origin_full_name":{"$ref":"#/components/schemas/origin_full_name"},"first_name":{"$ref":"#/components/schemas/first_name"},"origin_first_name":{"$ref":"#/components/schemas/origin_first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"origin_last_name":{"$ref":"#/components/schemas/origin_last_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"origin_middle_name":{"$ref":"#/components/schemas/origin_middle_name"},"dob":{"$ref":"#/components/schemas/dob"},"residence_country":{"$ref":"#/components/schemas/residence_country"},"gender":{"$ref":"#/components/schemas/gender"},"description":{"$ref":"#/components/schemas/description"},"bdb_name":{"$ref":"#/components/schemas/bdb_name"},"aliases":{"type":"array","items":{"type":"object"}},"addresses":{"type":"array","items":{"type":"object"}},"name_match_score":{"$ref":"#/components/schemas/name_match_score"},"total_match_score":{"$ref":"#/components/schemas/total_match_score"}}}}}}}},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"oneOf":[{"title":"A parameter is absent or has empty value","type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"first_name"},"message":{"type":"string","example":"Value must be between 1 and 64 characters"}}}}}},{"title":"A value exceeds minimum or maximum length","type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"first_name"},"message":{"type":"string","example":"Value must be between 1 and 64 characters"}}}}}},{"title":"A value has wrong format or data type","type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"first_name"},"message":{"type":"string","example":"Value must have correct format or data type"}}}}}},{"title":"A value has wrong format or data type","type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"gender"},"message":{"type":"string","example":"Value must be from the list of allowed values"}}}}}}]},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","title":"Search by a document number","properties":{"document_number":{"$ref":"#/components/schemas/document_number--bdb--documents"},"document_type":{"$ref":"#/components/schemas/document_type"},"document_country":{"$ref":"#/components/schemas/document_country"},"bdb_types":{"$ref":"#/components/schemas/bdb_type"}},"required":["document_number"]},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","title":"Search by a tax ID number","properties":{"tax_id_number":{"$ref":"#/components/schemas/tax_id_number"},"tax_id_country":{"$ref":"#/components/schemas/tax_id_country"},"bdb_types":{"$ref":"#/components/schemas/bdb_type"}},"required":["tax_id_number"]},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/bdb--tax-ids--200"},{"$ref":"#/components/schemas/bdb--tax-ids--200--not_found"}]},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/bdb--tax-ids--422--bdb_types"},{"$ref":"#/components/schemas/bdb--tax-ids--422--tax_id_country"}]},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"primary_keywords":{"$ref":"#/components/schemas/primary_keywords"},"secondary_keywords":{"$ref":"#/components/schemas/secondary_keywords"},"callback_url":{"$ref":"#/components/schemas/callback_url"}},"required":["primary_keywords","callback_url"]},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","title":"Information received","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"primary_keywords":{"$ref":"#/components/schemas/primary_keywords"},"secondary_keywords":{"$ref":"#/components/schemas/secondary_keywords"},"callback_url":{"$ref":"#/components/schemas/callback_url"}},"example":{"primary_keywords":["John","Smith","corruption","money laundering","murder"],"secondary_keywords":["sanctioned","whistleblower","conviction"],"callback_url":"https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03"}}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"hash":{"$ref":"#/components/schemas/hash"},"asset":{"$ref":"#/components/schemas/asset"},"callback_url":{"$ref":"#/components/schemas/callback_url"}},"required":["hash","asset","callback_url"]},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"service_request_id":{"type":"string","example":"6bff21e17da144418b7643267ba4502930a9"}}}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Form token authentication is not allowed","properties":{"type":{"type":"string","example":"forbidden"},"errors":{"type":"array","example":[]}}},{"type":"object","title":"Test mode is not allowed","properties":{"type":{"type":"string","example":"forbidden"},"errors":{"type":"array","example":[]}}},{"type":"object","title":"Service API is not available for this account","properties":{"type":{"type":"string","example":"forbidden"},"errors":{"type":"array","example":[]}}}]},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Invalid hash","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"hash"},"message":{"type":"string","example":"hash is required. The length should be from 16 to 128 characters"}}}}}},{"type":"object","title":"Invalid asset","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"asset"},"message":{"type":"string","example":"asset is not valid. Possible options: BTC, BCH, LTC, XRP, ETC, ADA, ETH, TRX, ALGO, XLM, MATIC, ZEC, DOGE, SOL, BSV, AVAX, ARB, DOT, TetherOMNI, TON, XTZ, NEAR"}}}}}},{"type":"object","title":"Invalid callback URL","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"callback_url"},"message":{"type":"string","example":"Callback URL is not valid"}}}}}}]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"hash":{"$ref":"#/components/schemas/hash"},"address":{"$ref":"#/components/schemas/crypto--address"},"asset":{"$ref":"#/components/schemas/asset"},"direction":{"$ref":"#/components/schemas/direction--crypto"},"callback_url":{"$ref":"#/components/schemas/callback_url"}},"required":["hash","address","asset","direction","callback_url"]},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Invalid hash","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"hash"},"message":{"type":"string","example":"hash is required. The length should be from 16 to 128 characters"}}}}}},{"type":"object","title":"Invalid address","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"address"},"message":{"type":"string","example":"address is required. The length should be from 16 to 128 characters"}}}}}},{"type":"object","title":"Invalid asset","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"asset"},"message":{"type":"string","example":"asset is not valid. Possible options: BTC, BCH, LTC, XRP, ETC, ADA, ETH, TRX, ALGO, XLM, MATIC, ZEC, DOGE, SOL, BSV, AVAX, ARB, DOT, TetherOMNI, TON, XTZ, NEAR"}}}}}},{"type":"object","title":"Invalid direction","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"direction"},"message":{"type":"string","example":"direction is not valid. Possible options: deposit, withdrawal"}}}}}},{"type":"object","title":"Invalid callback URL","properties":{"status":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"callback_url"},"message":{"type":"string","example":"Callback URL is not valid"}}}}}}]},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"applicant_id":{"$ref":"#/components/schemas/applicant_id"},"external_applicant_id":{"$ref":"#/components/schemas/external_applicant_id"},"external_applicant_registered_at":{"$ref":"#/components/schemas/external_applicant_registered_at"},"transaction":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/transaction_monitoring_direction"},"amount":{"$ref":"#/components/schemas/transaction_monitoring_amount"},"asset":{"$ref":"#/components/schemas/transaction_monitoring_asset"},"created_at":{"$ref":"#/components/schemas/transaction_monitoring_created_at"}}},"ruleset_id":{"$ref":"#/components/schemas/ruleset_id"}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"data":{"type":"object","properties":{"service_request_id":{"type":"string","example":"6bff21e17da144418b7643267ba4502930a9"}}}}},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"No applicant ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"applicant_id"},"message":{"type":"string","example":"Either 'applicant_id' or 'external_applicant_id' is required"}}}}}},{"type":"object","title":"Invalid applicant ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"applicant_id"},"message":{"type":"string","example":"Value must be exactly 36 characters long"}}}}}},{"type":"object","title":"No external applicant ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"external_applicant_id"},"message":{"type":"string","example":"Either 'applicant_id' or 'external_applicant_id' is required"}}}}}},{"type":"object","title":"Invalid external applicant ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"external_applicant_id"},"message":{"type":"string","example":"Value must be up to 50 characters"}}}}}},{"type":"object","title":"No external applicant registration date and time","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"external_applicant_registered_at"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"External applicant registration date and time must have correct format","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"external_applicant_registered_at"},"message":{"type":"string","example":"Value must be in YYYY-MM-DD hh:mm:ss format"}}}}}},{"type":"object","title":"External applicant registration date and time cannot be in the future","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"external_applicant_registered_at"},"message":{"type":"string","example":"Value cannot be in the future"}}}}}},{"type":"object","title":"No transaction direction","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.direction"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid transaction direction","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.direction"},"message":{"type":"string","example":"Value must be either 'incoming' or 'outgoing'"}}}}}},{"type":"object","title":"No transaction amount","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.amount"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid transaction amount","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.amount"},"message":{"type":"string","example":"Value must be positive numeric string"}}}}}},{"type":"object","title":"No transaction asset","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.asset"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid transaction asset","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.asset"},"message":{"type":"string","example":"Value must be a valid asset ticker (e.g., USD, BTC, SOL)"}}}}}},{"type":"object","title":"No transaction creation time","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.created_at"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid transaction creation time","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"transaction.created_at"},"message":{"type":"string","example":"Value must be in YYYY-MM-DD hh:mm:ss format"}}}}}},{"type":"object","title":"No ruleset ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"ruleset_id"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid ruleset ID","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"ruleset_id"},"message":{"type":"string","example":"Value must be exactly 36 characters long"}}}}}},{"type":"object","title":"No callback URL","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"callback_url"},"message":{"type":"string","example":"Parameter is required"}}}}}},{"type":"object","title":"Invalid callback URL","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"callback_url"},"message":{"type":"string","example":"Value must be up to 2048 characters"}}}}}}]},"id":"schema_173"}},"exampleStore":{},"securitySchemeStore":{"API-Key":{"id":"API-Key","type":"apiKey","in":"header","paramName":"API-Key"}},"servers":[{"url":"https://api.kycaid.com"}],"specType":"openapi"},"options":{"layout":"three-panel","jsonSamplesExpandLevel":"all","hideSchemaTitles":true,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"Payload","label":"payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"R"},{"lang":"Ruby"}]},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/risks-check.json?download"},{"url":"/_bundle/risks-check.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview"}},"baseSlug":"/risks-check","routesMapping":{}}