API referenceVerify
Verify a national identity number in bulk
Validates up to 100 values of this type in one call, each counting as one check toward usage. A value that fails validation reports its reason inside the result envelope instead of failing the request.
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 list of national_id values to verify in one call.
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/batch" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "country": "AE", "value": "784-1990-1234567-6" } ] }'{ "meta": { "credits_used": 0 }, "results": [ { "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 } ], "summary": { "invalid": 0, "total": 0, "valid": 0 }}