{"items":[{"type":"link","label":"Overview","link":"/non-doc","routeSlug":"/non-doc","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"non-doc.json","url":"/_bundle/non-doc.json?download"},{"kind":"download","label":"non-doc.yaml","url":"/_bundle/non-doc.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":"/non-doc"}]}]}},{"type":"group","label":"🇧🇷 Brazil","link":"/non-doc/brazil","routeSlug":"/non-doc/brazil","items":[{"label":"CPF number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/brazil/br-cpf","routeSlug":"/non-doc/brazil/br-cpf","metadata":{"seo":{"title":"CPF number","description":"The Brazil CPF verification service allows you to verify the identity of an individual in Brazil using their individual taxpayer identification number (Cadastro de Pessoas Físicas). The service returns the person’s full name, date of birth, and gender"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"br-cpf","name":"CPF number","isWebhook":false,"pointer":"/paths/~1services~1br~1cpf~1{cpf_number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CPF number","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":"The Brazil CPF verification service allows you to verify the identity of an individual in Brazil using their individual taxpayer identification number (Cadastro de Pessoas Físicas). The service returns the person’s full name, date of birth, and gender"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cpf_number","in":"path","schemaId":"schema_87","required":true}],"pointer":"/paths/~1services~1br~1cpf~1{cpf_number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/br/cpf/{cpf_number}","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[{"name":"cpf_number","in":"path","required":true,"example":"00388415129","schemaId":"components/schemas/cpf_number"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","402","422","500","502"],"pointer":"/services/br/cpf/{cpf_number}","href":"brazil/br-cpf","openApiOperationId":"br-cpf","summary":"CPF number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"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_88"}},"schemaId":"schema_88"},{"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_89"}},"schemaId":"schema_89"},{"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~1br~1cpf~1{cpf_number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_88","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_88"}}},{"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_89","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89"}}},{"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":"/brazil/br-cpf"}],"panels":[]}]},"httpPath":"/services/br/cpf/{cpf_number}"},{"label":"CPF number (alternative)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/brazil/br-cpf-2","routeSlug":"/non-doc/brazil/br-cpf-2","metadata":{"seo":{"title":"CPF number (alternative)","description":"The alternative Brazil CPF verification service allows you to verify the identity of an individual in Brazil using their individual taxpayer identification number (Cadastro de Pessoas Físicas). The service returns the person’s full name, date of birth, and CPF registration status, including whether the CPF is active, suspended, or cancelled. No document upload is required for verification. This enables quick and automated identity checks against official records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"br-cpf-2","name":"CPF number (alternative)","isWebhook":false,"pointer":"/paths/~1services~1br~1cpf~12~1{cpf_number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CPF number (alternative)","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":"The alternative Brazil CPF verification service allows you to verify the identity of an individual in Brazil using their individual taxpayer identification number (Cadastro de Pessoas Físicas). The service returns the person’s full name, date of birth, and CPF registration status, including whether the CPF is active, suspended, or cancelled. No document upload is required for verification. This enables quick and automated identity checks against official records."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"API-Key","scopes":[],"type":"apiKey","in":"header","paramName":"API-Key"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cpf_number","in":"path","schemaId":"schema_87","required":true}],"pointer":"/paths/~1services~1br~1cpf~12~1{cpf_number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/br/cpf/2/{cpf_number}","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[{"name":"cpf_number","in":"path","required":true,"example":"00388415129","schemaId":"components/schemas/cpf_number"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","402","422","500","502"],"pointer":"/services/br/cpf/2/{cpf_number}","href":"brazil/br-cpf-2","openApiOperationId":"br-cpf-2","summary":"CPF number (alternative)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"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_90"}},"schemaId":"schema_90"},{"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_89"}},"schemaId":"schema_89"},{"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~1br~1cpf~12~1{cpf_number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_90","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_90"}}},{"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_89","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_89"}}},{"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":"/brazil/br-cpf-2"}],"panels":[]}]},"httpPath":"/services/br/cpf/2/{cpf_number}"}],"content":{"contentType":"group","meta":{"name":"🇧🇷 Brazil"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇧🇷 Brazil","showPageActions":true},{"nodeType":"markdoc","content":"Brazil"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/br/cpf/{cpf_number}","summary":"CPF number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brazil/br-cpf","deprecated":false},{"title":"/services/br/cpf/2/{cpf_number}","summary":"CPF number (alternative)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/brazil/br-cpf-2","deprecated":false}]}]}]}]}},{"type":"group","label":"🇮🇳 India","link":"/non-doc/india","routeSlug":"/non-doc/india","items":[{"label":"Aadhaar number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/india/in-aadhaar","routeSlug":"/non-doc/india/in-aadhaar","metadata":{"seo":{"title":"Aadhaar number","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"in-aadhaar","name":"Aadhaar number","isWebhook":false,"pointer":"/paths/~1services~1in~1aadhaar~1generate-otp/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Aadhaar number","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/#in-aadhaar-card"},"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/in/aadhaar/generate-otp","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/in/aadhaar/generate-otp","href":"india/in-aadhaar","openApiOperationId":"in-aadhaar","summary":"Aadhaar number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/india/in-aadhaar"}],"panels":[]}]},"httpPath":"/services/in/aadhaar/generate-otp"}],"content":{"contentType":"group","meta":{"name":"🇮🇳 India"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇮🇳 India","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇮🇳 India"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/in/aadhaar/generate-otp","summary":"Aadhaar number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/india/in-aadhaar","deprecated":false}]}]}]}]}},{"type":"group","label":"🇰🇿 Kazakhstan","link":"/non-doc/kazakhstan","routeSlug":"/non-doc/kazakhstan","items":[{"label":"IIN (basic)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/kazakhstan/kz-iin-basic","routeSlug":"/non-doc/kazakhstan/kz-iin-basic","metadata":{"seo":{"title":"IIN (basic)","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kz-iin-basic","name":"IIN (basic)","isWebhook":false,"pointer":"/paths/~1services~1kz~1iin~1request/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IIN (basic)","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/#kz-iin"},"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/kz/iin/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/kz/iin/request","href":"kazakhstan/kz-iin-basic","openApiOperationId":"kz-iin-basic","summary":"IIN (basic)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kazakhstan/kz-iin-basic"}],"panels":[]}]},"httpPath":"/services/kz/iin/request"},{"label":"IIN (extended)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/kazakhstan/kz-iin-extended","routeSlug":"/non-doc/kazakhstan/kz-iin-extended","metadata":{"seo":{"title":"IIN (extended)","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kz-iin-extended","name":"IIN (extended)","isWebhook":false,"pointer":"/paths/~1services~1kz~1personal-data~1request/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IIN (extended)","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/#kz-personal-data"},"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/kz/personal-data/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/kz/personal-data/request","href":"kazakhstan/kz-iin-extended","openApiOperationId":"kz-iin-extended","summary":"IIN (extended)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/kazakhstan/kz-iin-extended"}],"panels":[]}]},"httpPath":"/services/kz/personal-data/request"}],"content":{"contentType":"group","meta":{"name":"🇰🇿 Kazakhstan"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇰🇿 Kazakhstan","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇰🇿 Kazakhstan"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/kz/iin/request","summary":"IIN (basic)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kazakhstan/kz-iin-basic","deprecated":false},{"title":"/services/kz/personal-data/request","summary":"IIN (extended)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/kazakhstan/kz-iin-extended","deprecated":false}]}]}]}]}},{"type":"group","label":"🇲🇽 Mexico","link":"/non-doc/mexico","routeSlug":"/non-doc/mexico","items":[{"label":"CURP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/mexico/mx-curp","routeSlug":"/non-doc/mexico/mx-curp","metadata":{"seo":{"title":"CURP","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mx-curp","name":"CURP","isWebhook":false,"pointer":"/paths/~1services~1mx~1curp~1curp_number/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"CURP","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/#mx-curp"},"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":"GET","path":"/services/mx/curp/curp_number","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/mx/curp/curp_number","href":"mexico/mx-curp","openApiOperationId":"mx-curp","summary":"CURP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mexico/mx-curp"}],"panels":[]}]},"httpPath":"/services/mx/curp/curp_number"}],"content":{"contentType":"group","meta":{"name":"🇲🇽 Mexico"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇲🇽 Mexico","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇲🇽 Mexico"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/mx/curp/curp_number","summary":"CURP","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mexico/mx-curp","deprecated":false}]}]}]}]}},{"type":"group","label":"🇳🇬 Nigeria","link":"/non-doc/nigeria","routeSlug":"/non-doc/nigeria","items":[{"label":"NIN","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/nigeria/ng-nin","routeSlug":"/non-doc/nigeria/ng-nin","metadata":{"seo":{"title":"NIN","description":"The Nigeria NIN (National Identification Number) service provides a method for checking and confirming person idenitity using their NIN. It utilizes the provided 11-digit NIN to query the official national database. The service returns a detailed response including the NIN holder's registered identity data (full name, date of birth, address, and gender) upon a successful match."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ng-nin","name":"NIN","isWebhook":false,"pointer":"/paths/~1services~1ng~1nin/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NIN","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Nigeria NIN (National Identification Number) service provides a method for checking and confirming person idenitity using their NIN. It utilizes the provided 11-digit NIN to query the official national database. The service returns a detailed response including the NIN holder's registered identity data (full name, date of birth, address, and gender) upon a successful match.\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_91"}},"schemaId":"schema_91","pointer":"/paths/~1services~1ng~1nin/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/ng/nin","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_91"}},"responseCodes":["200","400","402","404","422","500","502"],"pointer":"/services/ng/nin","href":"nigeria/ng-nin","openApiOperationId":"ng-nin","summary":"NIN"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_91","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_91"}},"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_92"}},"schemaId":"schema_92"},{"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_93"}},"schemaId":"schema_93"},{"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_94"}},"schemaId":"schema_94"},{"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~1ng~1nin/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_92","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_92"}}},{"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_93","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_93"}}},{"code":"422","schemaId":"schema_94","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_94"}}},{"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":"/nigeria/ng-nin"}],"panels":[]}]},"httpPath":"/services/ng/nin"}],"content":{"contentType":"group","meta":{"name":"🇳🇬 Nigeria"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇳🇬 Nigeria","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇳🇬 Nigeria"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/ng/nin","summary":"NIN","prefix":{"name":"post","color":"post"},"badges":[],"link":"/nigeria/ng-nin","deprecated":false}]}]}]}]}},{"type":"group","label":"🇵🇪 Peru","link":"/non-doc/peru","routeSlug":"/non-doc/peru","items":[{"label":"DNI number (extended)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/peru/pe-dni-extended","routeSlug":"/non-doc/peru/pe-dni-extended","metadata":{"seo":{"title":"DNI number (extended)","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pe-dni-extended","name":"DNI number (extended)","isWebhook":false,"pointer":"/paths/~1services~1pe~1dni-extra~1{dni_number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DNI number (extended)","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/#pe-dni-extra"},"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"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dni_number","in":"path","schemaId":"schema_95","required":true}],"pointer":"/paths/~1services~1pe~1dni-extra~1{dni_number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/pe/dni-extra/{dni_number}","servers":[{"url":"https://api.kycaid.com"}],"parameters":{"path":[{"name":"dni_number","in":"path","required":true,"schemaId":"schema_95"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"API-Key","type":"apiKey","name":"API-Key","in":"header"}],"scopes":[]}],"pointer":"/services/pe/dni-extra/{dni_number}","href":"peru/pe-dni-extended","openApiOperationId":"pe-dni-extended","summary":"DNI number (extended)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peru/pe-dni-extended"}],"panels":[]}]},"httpPath":"/services/pe/dni-extra/{dni_number}"}],"content":{"contentType":"group","meta":{"name":"🇵🇪 Peru"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇵🇪 Peru","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇵🇪 Peru"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/pe/dni-extra/{dni_number}","summary":"DNI number (extended)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peru/pe-dni-extended","deprecated":false}]}]}]}]}},{"type":"group","label":"🇿🇦 South Africa","link":"/non-doc/south-africa","routeSlug":"/non-doc/south-africa","items":[{"label":"SAID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/south-africa/za-said","routeSlug":"/non-doc/south-africa/za-said","metadata":{"seo":{"title":"SAID","description":"Verify the identity of an individual in South Africa using only their 13-digit South African ID number (SAID). The service queries official records and returns the core identity profile tied to that number – first name, last name, date of birth, gender, citizenship status, and whether the person is recorded as deceased – giving you a fast, reliable way to confirm who someone is"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"za-said","name":"SAID","isWebhook":false,"pointer":"/paths/~1services~1za~1said/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SAID","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":"Verify the identity of an individual in South Africa using only their 13-digit South African ID number (SAID). The service queries official records and returns the core identity profile tied to that number – first name, last name, date of birth, gender, citizenship status, and whether the person is recorded as deceased – giving you a fast, reliable way to confirm who someone is"},"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","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96","pointer":"/paths/~1services~1za~1said/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/za/said","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_96"}},"responseCodes":["200","400","402","404","500","502"],"pointer":"/services/za/said","href":"south-africa/za-said","openApiOperationId":"za-said","summary":"SAID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"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_97"}},"schemaId":"schema_97"},{"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_95"}},"schemaId":"schema_95"},{"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~1za~1said/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_97","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_97"}}},{"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_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"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":"/south-africa/za-said"}],"panels":[]}]},"httpPath":"/services/za/said"},{"label":"SAID with photo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/south-africa/za-said-photo","routeSlug":"/non-doc/south-africa/za-said-photo","metadata":{"seo":{"title":"SAID with photo","description":"Confirm a person’s identity in South Africa from their 13-digit South African ID number (SAID) and put a face to the record. Alongside the core identity details – first name, last name, date of birth, gender, citizenship status, and deceased status – this service also returns the individual's official photograph, making it well suited to flows where visual confirmation matters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"za-said-photo","name":"SAID with photo","isWebhook":false,"pointer":"/paths/~1services~1za~1said-photo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SAID with photo","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":"Confirm a person’s identity in South Africa from their 13-digit South African ID number (SAID) and put a face to the record. Alongside the core identity details – first name, last name, date of birth, gender, citizenship status, and deceased status – this service also returns the individual's official photograph, making it well suited to flows where visual confirmation matters"},"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","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96","pointer":"/paths/~1services~1za~1said-photo/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/za/said-photo","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_96"}},"responseCodes":["200","400","402","404","500","502"],"pointer":"/services/za/said-photo","href":"south-africa/za-said-photo","openApiOperationId":"za-said-photo","summary":"SAID with photo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_96"}},"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_98"}},"schemaId":"schema_98"},{"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_95"}},"schemaId":"schema_95"},{"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~1za~1said-photo/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_98","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_98"}}},{"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_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"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":"/south-africa/za-said-photo"}],"panels":[]}]},"httpPath":"/services/za/said-photo"},{"label":"SAID name match","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/south-africa/za-said-name-match","routeSlug":"/non-doc/south-africa/za-said-name-match","metadata":{"seo":{"title":"SAID name match","description":"The South African name match service provides automated, remote identity verification for individuals within South Africa. It uses a person's South African ID number (SAID) together with their first name and last name to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"za-said-name-match","name":"SAID name match","isWebhook":false,"pointer":"/paths/~1services~1za~1said~1name-match/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SAID name match","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The South African name match service provides automated, remote identity verification for individuals within South Africa. It uses a person's South African ID number (SAID) together with their first name and last name to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks\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_99"}},"schemaId":"schema_99","pointer":"/paths/~1services~1za~1said~1name-match/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/za/said/name-match","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_99"}},"responseCodes":["200","400","402","404","500","502"],"pointer":"/services/za/said/name-match","href":"south-africa/za-said-name-match","openApiOperationId":"za-said-name-match","summary":"SAID name match"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_99","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99"}},"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_100"}},"schemaId":"schema_100"},{"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_95"}},"schemaId":"schema_95"},{"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~1za~1said~1name-match/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_100","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_100"}}},{"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_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"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":"/south-africa/za-said-name-match"}],"panels":[]}]},"httpPath":"/services/za/said/name-match"}],"content":{"contentType":"group","meta":{"name":"🇿🇦 South Africa"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇿🇦 South Africa","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇿🇦 South Africa"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/za/said","summary":"SAID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/south-africa/za-said","deprecated":false},{"title":"/services/za/said-photo","summary":"SAID with photo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/south-africa/za-said-photo","deprecated":false},{"title":"/services/za/said/name-match","summary":"SAID name match","prefix":{"name":"post","color":"post"},"badges":[],"link":"/south-africa/za-said-name-match","deprecated":false}]}]}]}]}},{"type":"group","label":"🇹🇷 Turkey","link":"/non-doc/turkey","routeSlug":"/non-doc/turkey","items":[{"label":"Türkiye Cumhuriyeti Kimlik Numarası","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/turkey/tr-tckn","routeSlug":"/non-doc/turkey/tr-tckn","metadata":{"seo":{"title":"Türkiye Cumhuriyeti Kimlik Numarası","description":"Please refer to the legacy documentation for this article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tr-tckn","name":"Türkiye Cumhuriyeti Kimlik Numarası","isWebhook":false,"pointer":"/paths/~1services~1tr~1identity-number/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Türkiye Cumhuriyeti Kimlik Numarası","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/#tr-identity-number"},"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/tr/identity-number","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/tr/identity-number","href":"turkey/tr-tckn","openApiOperationId":"tr-tckn","summary":"Türkiye Cumhuriyeti Kimlik Numarası"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/turkey/tr-tckn"}],"panels":[]}]},"httpPath":"/services/tr/identity-number"}],"content":{"contentType":"group","meta":{"name":"🇹🇷 Turkey"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇹🇷 Turkey","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇹🇷 Turkey"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/tr/identity-number","summary":"Türkiye Cumhuriyeti Kimlik Numarası","prefix":{"name":"post","color":"post"},"badges":[],"link":"/turkey/tr-tckn","deprecated":false}]}]}]}]}},{"type":"group","label":"🇺🇦 Ukraine","link":"/non-doc/ukraine","routeSlug":"/non-doc/ukraine","items":[],"content":{"contentType":"group","meta":{"name":"🇺🇦 Ukraine"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇺🇦 Ukraine","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇺🇦 Ukraine"},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ukraine"}],"panels":[]}]}},{"type":"group","label":"🇺🇸 USA","link":"/non-doc/usa","routeSlug":"/non-doc/usa","items":[{"label":"eIDV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/non-doc/usa/us-eidv","routeSlug":"/non-doc/usa/us-eidv","metadata":{"seo":{"title":"eIDV","description":"The USA eIDV (electronic Identity Verification) service provides automated, remote identity verification for individuals within the United States. It utilizes a person's first name, last name, and date of birth to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"us-eidv","name":"eIDV","isWebhook":false,"pointer":"/paths/~1services~1us~1eidv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"eIDV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The USA eIDV (electronic Identity Verification) service provides automated, remote identity verification for individuals within the United States. It utilizes a person's first name, last name, and date of birth to check against official records. The service returns a match score along with a detailed description of the verification outcome, enabling quick and reliable identity checks.\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_101"}},"schemaId":"schema_101","pointer":"/paths/~1services~1us~1eidv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/us/eidv","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_101"}},"responseCodes":["200","400","402","404","500","502"],"pointer":"/services/us/eidv","href":"usa/us-eidv","openApiOperationId":"us-eidv","summary":"eIDV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.kycaid.com"}],"schemaId":"schema_101","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_101"}},"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_102"}},"schemaId":"schema_102"},{"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_95"}},"schemaId":"schema_95"},{"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~1us~1eidv/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_102","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_102"}}},{"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_95","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_95"}}},{"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":"/usa/us-eidv"}],"panels":[]}]},"httpPath":"/services/us/eidv"}],"content":{"contentType":"group","meta":{"name":"🇺🇸 USA"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"🇺🇸 USA","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🇺🇸 USA"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/services/us/eidv","summary":"eIDV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usa/us-eidv","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/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/cpf_number":{"id":"components/schemas/cpf_number","kind":"json-schema","title":"CPF number","data":{"title":"CPF number","type":"string","minLength":11,"maxLength":11,"example":"00388415129","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brazilian individual taxpayer identification number (Cadastro de Pessoas Físicas), consisting of 11 numeric digits without formatting (no dots or hyphens)"},"children":[]}]}]}]}},"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/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/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/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/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/cpf_status":{"id":"components/schemas/cpf_status","kind":"json-schema","title":"cpf_status","data":{"type":"string","example":"Regular","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descriptive status of the CPF number, based on official data. Indicates the current registration condition of the CPF holder - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Regular"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Valid (CPF is active and in good standing) - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Suspensa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Suspended (CPF is temporarily inactive) - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelada"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Canceled (CPF has been officially canceled) - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pendente"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending regularisation (CPF requires corrective action) - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Nula"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Null (CPF was never issued or is invalid)"},"children":[]}]}]}]}},"components/schemas/cpf_status_code":{"id":"components/schemas/cpf_status_code","kind":"json-schema","title":"cpf_status_code","data":{"type":"string","enum":["00","02","03","04","05","08","09"],"example":"00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code of the CPF number, based on official data - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Valid (CPF is active and in good standing)   - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Suspended (CPF is temporarily inactive)   - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"03"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Canceled (CPF has been officially canceled)   - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"05"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Pending regularisation (CPF requires corrective action)   - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"08"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Null (CPF was never issued or is invalid)"},"children":[]}]}]}]}},"components/schemas/cpf_status_reason":{"id":"components/schemas/cpf_status_reason","kind":"json-schema","title":"cpf_status_reason","data":{"type":"string","example":"REGULAR","description":"Human-readable reason for the current CPF registration status, as provided by officials. Explains why the CPF holds its specific status (e.g., suspension due to missing tax declarations, cancellation by request, invalid registration, death)\n"}},"components/schemas/year_of_death":{"id":"components/schemas/year_of_death","kind":"json-schema","title":"year_of_death","data":{"type":["integer","null"],"format":"int32","example":null,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calendar year in which the individual was reported deceased, based on available records. The field may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the information is not applicable"},"children":[]}]}]}]}},"components/schemas/nin":{"id":"components/schemas/nin","kind":"json-schema","title":"NIN","data":{"title":"NIN","type":"string","minLength":11,"maxLength":11,"example":"38109457262","description":"The Nigerian National Identification Number (NIN), a unique 11-digit identifier issued by the National Identity Management Commission (NIMC)"}},"components/schemas/phone":{"id":"components/schemas/phone","kind":"json-schema","title":"Phone number","data":{"title":"Phone number","type":["string","null"],"minLength":1,"maxLength":15,"example":"441172345678","description":"The phone number of a person or a company"}},"components/schemas/email":{"id":"components/schemas/email","kind":"json-schema","title":"Email address","data":{"title":"Email address","type":["string","null"],"format":"email","minLength":1,"maxLength":254,"example":"josh.coffey@example.com","description":"The email address of a person or a company"}},"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/profile_image":{"id":"components/schemas/profile_image","kind":"json-schema","title":"Profile image","data":{"title":"Profile image","type":"string","format":"binary","example":"/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwA[...]","description":"A profile image of a person in base64 binary format"}},"components/schemas/country":{"id":"components/schemas/country","kind":"json-schema","title":"country","data":{"type":["string","null"],"minLength":2,"maxLength":2,"example":"GB","description":"A country of an object. A two-letter country code according to ISO 3166-2"}},"components/schemas/state":{"id":"components/schemas/state","kind":"json-schema","title":"State","data":{"title":"State","type":["string","null"],"minLength":1,"maxLength":50,"example":null,"description":"A state of a person or a company"}},"components/schemas/district":{"id":"components/schemas/district","kind":"json-schema","title":"district","data":{"type":["string","null"],"minLength":1,"maxLength":50,"example":"Westminster","description":"The district (an area of a city) of an object"}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"Address","data":{"title":"Address","type":["string","null"],"minLength":1,"maxLength":50,"example":"45 High Street, Flat 2A","description":"An address (a street name, a building number, and a unit number) of a person or a company"}},"components/schemas/city":{"id":"components/schemas/city","kind":"json-schema","title":"City","data":{"title":"City","type":["string","null"],"minLength":1,"maxLength":50,"example":"London","description":"A city or a town of a person or a company"}},"components/schemas/postal_code":{"id":"components/schemas/postal_code","kind":"json-schema","title":"Postal code","data":{"title":"Postal code","type":["string","null"],"minLength":1,"maxLength":20,"example":"SW1A 1AA","description":"A postal code (zip code, postcode) of a person or a company"}},"components/schemas/ssn":{"id":"components/schemas/ssn","kind":"json-schema","title":"Social Security Number (SSN)","data":{"title":"Social Security Number (SSN)","type":["string","null"],"minLength":4,"maxLength":9,"example":"545180772","description":"The US Social Security Number of a person (SSN). The value must be an unformatted string of digits, either 4 digits (partial) or exactly 9 digits (full). No dashes, spaces, or other characters are allowed"}},"components/schemas/drivers_license":{"id":"components/schemas/drivers_license","kind":"json-schema","title":"Driver’s license number","data":{"title":"Driver’s license number","type":["string","null"],"minLength":7,"maxLength":14,"example":"P620-7949","description":"The unique driver identification number issued by a US state or territory. It is a mix of numbers and letters, and its format is state-dependent"}},"components/schemas/match_score":{"id":"components/schemas/match_score","kind":"json-schema","title":"US eIDV match score","data":{"title":"US eIDV match score","type":["number","null"],"format":"float","minimum":0,"maximum":100,"example":80,"description":"Overall identity match score"}},"components/schemas/name_match":{"id":"components/schemas/name_match","kind":"json-schema","title":"Full name match","data":{"title":"Full name match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s full name during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s full name has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s full name address partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s full name address did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/dob_match":{"id":"components/schemas/dob_match","kind":"json-schema","title":"Date of birth match","data":{"title":"Date of birth match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s date of birth during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s date of birth has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s date of birth partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s date of birth did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/address_match":{"id":"components/schemas/address_match","kind":"json-schema","title":"Address match","data":{"title":"Address match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s address during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s address has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s address partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s address did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/city_match":{"id":"components/schemas/city_match","kind":"json-schema","title":"City match","data":{"title":"City match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s city during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s city has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s city partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s city did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/state_match":{"id":"components/schemas/state_match","kind":"json-schema","title":"State match","data":{"title":"State match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s state during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s state has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s state partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s state did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/postal_code_match":{"id":"components/schemas/postal_code_match","kind":"json-schema","title":"Postal code (ZIP) match","data":{"title":"Postal code (ZIP) match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s postal code (ZIP) during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s postal code (ZIP) has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s postal code (ZIP) partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s postal code (ZIP) did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/phone_match":{"id":"components/schemas/phone_match","kind":"json-schema","title":"Phone number match","data":{"title":"Phone number match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s phone number"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s phone number has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s phone number partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s phone number did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/email_match":{"id":"components/schemas/email_match","kind":"json-schema","title":"Email address match","data":{"title":"Email address match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s email address during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s email address has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s email address partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s email address did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/ssn_match":{"id":"components/schemas/ssn_match","kind":"json-schema","title":"Social Security Number (SSN) match","data":{"title":"Social Security Number (SSN) match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of match found for the person’s Social Security Number (SSN) during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s SSN has a total match against the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s SSN partially matches the record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s SSN did not match a record in the database"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/drivers_license_match":{"id":"components/schemas/drivers_license_match","kind":"json-schema","title":"Driver’s license number match","data":{"title":"Driver’s license number match","type":["string","null"],"enum":["MATCH","PARTIAL_MATCH","NO_MATCH",null],"example":"NO_MATCH","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| The type of match found for the person’s driver’s license number during US eIDV verification"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s driver’s license number has a total match against the record in the database - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PARTIAL_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s driver’s license number partially matches the record in the database - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_MATCH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The person’s driver’s license number did not match a record in the database - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No data was provided in the request"},"children":[]}]}]}]}]}},"components/schemas/said_number":{"id":"components/schemas/said_number","kind":"json-schema","title":"South African ID number","data":{"title":"South African ID number","type":"string","minLength":13,"maxLength":13,"example":"8001015009031","description":"South African 13-digit national identity number in the format YYMMDDSSSSCAZ: YYMMDD is the date of birth, SSSS is a gender code (0000-4999 female, 5000-9999 male), C is the citizenship indicator   (0 citizen, 1 permanent resident), A is a historical digit, and Z is  a Luhn checksum digit."}},"components/schemas/is_citizen":{"id":"components/schemas/is_citizen","kind":"json-schema","title":"Citizenship status","data":{"title":"Citizenship status","type":"boolean","example":true,"description":"Indicates whether the person is a South African citizen. True for a citizen, false for a permanent resident. Derived from the eleventh digit of the South African ID number (0 for citizen, 1 for permanent resident)"}},"components/schemas/is_deceased":{"id":"components/schemas/is_deceased","kind":"json-schema","title":"Deceased status","data":{"title":"Deceased status","type":"boolean","example":false,"description":"Indicates whether the person is recorded as deceased. True if a death has been registered, false otherwise"}},"components/schemas/photo_base64":{"id":"components/schemas/photo_base64","kind":"json-schema","title":"Photo, base64-encoded","data":{"title":"Photo, base64-encoded","type":"string","example":"/9j/4A...","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person’s photograph encoded as a base64 string"},"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/service_first_name":{"id":"components/schemas/service_first_name","kind":"json-schema","title":"First name returned by service","data":{"title":"First name returned by service","type":"string","example":"Josh","description":"The first name returned by an external service for comparison with the submitted value"}},"components/schemas/service_last_name":{"id":"components/schemas/service_last_name","kind":"json-schema","title":"Last name returned by service","data":{"title":"Last name returned by service","type":"string","format":"name","example":"Cofey","description":"The last name returned by an external service for comparison with the submitted value"}},"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"}},"schema_87":{"kind":"json-schema","data":{"$ref":"#/components/schemas/cpf_number"},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"object","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":true}}},"data":{"type":"object","properties":{"number":{"$ref":"#/components/schemas/cpf_number"},"name":{"$ref":"#/components/schemas/full_name"},"first_name":{"$ref":"#/components/schemas/first_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"}}}}},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"object","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":false}}},"data":{"type":"object","properties":{"cpf_number":{"type":"string","example":"00388415129"}}}}},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Infomation was found (person is alive)","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":true}}},"data":{"type":"object","properties":{"cpf_number":{"$ref":"#/components/schemas/cpf_number"},"full_name":{"$ref":"#/components/schemas/full_name"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"},"cpf_status":{"$ref":"#/components/schemas/cpf_status"},"cpf_status_code":{"$ref":"#/components/schemas/cpf_status_code"},"cpf_status_reason":{"$ref":"#/components/schemas/cpf_status_reason"},"year_of_death":{"$ref":"#/components/schemas/year_of_death"}}}}},{"type":"object","title":"Information was found (person is dead)","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":true}}},"data":{"type":"object","properties":{"cpf_number":{"allOf":[{"$ref":"#/components/schemas/cpf_number"},{"example":"13550106521"}]},"full_name":{"allOf":[{"$ref":"#/components/schemas/full_name"},{"example":"Michael Thompson"}]},"dob":{"allOf":[{"$ref":"#/components/schemas/dob"},{"example":"1971-07-01"}]},"gender":{"$ref":"#/components/schemas/gender"},"cpf_status":{"allOf":[{"$ref":"#/components/schemas/cpf_status"},{"example":"Cancelada"}]},"cpf_status_code":{"allOf":[{"$ref":"#/components/schemas/cpf_status_code"},{"example":"03"}]},"cpf_status_reason":{"allOf":[{"$ref":"#/components/schemas/cpf_status_reason"},{"example":"TITULAR FALECIDO"}]},"year_of_death":{"allOf":[{"$ref":"#/components/schemas/year_of_death"},{"example":"2009"}]}}}}}]},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"object","properties":{"nin_number":{"$ref":"#/components/schemas/nin"}}},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"object","title":"Data on NIN was found","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":true}}},"data":{"type":"object","properties":{"nin":{"$ref":"#/components/schemas/nin"},"first_name":{"$ref":"#/components/schemas/first_name"},"middle_name":{"$ref":"#/components/schemas/middle_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"dob":{"$ref":"#/components/schemas/dob"},"phone":{"$ref":"#/components/schemas/phone"},"email":{"$ref":"#/components/schemas/email"},"gender":{"$ref":"#/components/schemas/gender"},"residence_country":{"$ref":"#/components/schemas/residence_country"},"profile_image":{"$ref":"#/components/schemas/profile_image"},"address":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/country"},"state":{"$ref":"#/components/schemas/state"},"district":{"$ref":"#/components/schemas/district"},"address":{"$ref":"#/components/schemas/address"}}}}}}},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"object","title":"Data on NIN was not found","properties":{"validation":{"type":"object","properties":{"valid":{"type":"boolean","example":false}}},"data":{"type":"object","properties":{"nin":{"$ref":"#/components/schemas/nin"}}}}},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"oneOf":[{"title":"NIN number is required","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error is sent by our system when there is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nin_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in a request"},"children":[]}]}]}],"type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"nin_number"},"message":{"type":"string","example":"NIN number is required"}}}}}},{"title":"NIN number is not valid","description":"The error is sent by our system when NIN has wrong format","type":"object","properties":{"type":{"type":"string","example":"validation"},"errors":{"type":"array","items":{"type":"object","properties":{"parameter":{"type":"string","example":"nin_number"},"message":{"type":"string","example":"NIN number is not valid"}}}}}}]},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"object","properties":{"said_number":{"$ref":"#/components/schemas/said_number"}},"required":["said_number"]},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","title":"Information received","properties":{"data":{"type":"object","properties":{"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"},"is_citizen":{"$ref":"#/components/schemas/is_citizen"},"is_deceased":{"$ref":"#/components/schemas/is_deceased"}}}}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"object","title":"Information received","properties":{"data":{"type":"object","properties":{"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"},"is_citizen":{"$ref":"#/components/schemas/is_citizen"},"is_deceased":{"$ref":"#/components/schemas/is_deceased"},"photo_base64":{"$ref":"#/components/schemas/photo_base64"}}}}},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"type":"object","properties":{"said_number":{"$ref":"#/components/schemas/said_number"},"first_name":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/first_name"},{"type":"string"}]},{"type":"string","example":"Josh"}]},"last_name":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/last_name"},{"type":"string"}]},{"type":"string","example":"Coffey"}]},"name_match_threshold":{"$ref":"#/components/schemas/name_match_threshold"}},"required":["said_number","first_name","last_name","name_match_threshold"]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"type":"object","title":"Information received","properties":{"validation":{"type":"object","properties":{"valid":{"example":true}}},"data":{"type":"object","properties":{"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"service_first_name":{"$ref":"#/components/schemas/service_first_name"},"service_last_name":{"$ref":"#/components/schemas/service_last_name"},"dob":{"$ref":"#/components/schemas/dob"},"gender":{"$ref":"#/components/schemas/gender"},"is_citizen":{"$ref":"#/components/schemas/is_citizen"},"name_match_threshold":{"$ref":"#/components/schemas/name_match_threshold"},"name_match_score":{"$ref":"#/components/schemas/name_match_score"}}}}},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"type":"object","properties":{"first_name":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/first_name"},{"type":"string"}]},{"type":"string","example":"Josh"}]},"middle_name":{"$ref":"#/components/schemas/middle_name"},"last_name":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/last_name"},{"type":"string"}]},{"type":"string","example":"Coffey"}]},"dob":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/dob"},{"type":"string"}]},{"type":"string","example":"1976-02-21"}]},"address":{"$ref":"#/components/schemas/address"},"city":{"$ref":"#/components/schemas/city"},"state":{"$ref":"#/components/schemas/state"},"postal_code":{"$ref":"#/components/schemas/postal_code"},"phone":{"$ref":"#/components/schemas/phone"},"email":{"$ref":"#/components/schemas/email"},"ssn":{"$ref":"#/components/schemas/ssn"},"drivers_license":{"$ref":"#/components/schemas/drivers_license"}},"required":["first_name","last_name","dob"]},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"object","title":"Information received","properties":{"data":{"type":"object","properties":{"match_score":{"$ref":"#/components/schemas/match_score"},"name_match":{"$ref":"#/components/schemas/name_match"},"dob_match":{"$ref":"#/components/schemas/dob_match"},"address_match":{"$ref":"#/components/schemas/address_match"},"city_match":{"$ref":"#/components/schemas/city_match"},"state_match":{"$ref":"#/components/schemas/state_match"},"postal_code_match":{"$ref":"#/components/schemas/postal_code_match"},"phone_match":{"$ref":"#/components/schemas/phone_match"},"email_match":{"$ref":"#/components/schemas/email_match"},"ssn_match":{"$ref":"#/components/schemas/ssn_match"},"drivers_license_match":{"$ref":"#/components/schemas/drivers_license_match"}}}}},"id":"schema_102"}},"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/non-doc.json?download"},{"url":"/_bundle/non-doc.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview"}},"baseSlug":"/non-doc","routesMapping":{}}