Docs / Checks

List national ID types

Lists the country and type pairs accepted by the national ID check, each with a public test example.

GET/v1/validate
import { Client } from "@liveapiio/liveapi";

const client = new Client({ token: process.env.LIVEAPI_TOKEN });

const types = await client.idValidators();

Request

Send Authorization: Bearer YOUR_TOKEN. The token stays on your server. Each library reads it from the environment and calls this endpoint for you.

Response

A 200 response uses one call. Each item has country, type, name, example, and path.

Errors

A failed request returns { "error": { "code", "message" } } and does not use a call.

StatusCodeWhen
401unauthorizedThe bearer token is missing or not recognized.

We value your privacy

We use necessary cookies to run this website. With your consent, we would also like to use analytics and marketing cookies. Read our cookie policy.