API referenceVerify
Verify a national identity number
Confirms the number is a genuine national identity number and reports the encoded birth year.
Free for every account, and counts as one check toward usage.
The country is taken from the country field, then from the value itself when it carries a marker, then from the service default.
AuthorizationBearer <token>
API key sent as 'Authorization: Bearer'.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A national_id value to verify.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/verify/national-id" \ -H "Content-Type: application/json" \ -d '{ "value": "784-1990-1234567-6" }'{ "country": { "calling_code": "971", "code": "AE", "name": "United Arab Emirates" }, "details": { "birth_year": 0, "check_digit": "string", "scheme": "Emirates ID" }, "formatted": { "international": "+971 50 123 4567", "national": "050 123 4567" }, "input": "string", "normalized": "string", "reason": "empty_input", "type": "phone", "valid": true, "meta": { "credits_used": 0 }}