Table of Contents
| Table of Contents |
|---|
ℹ️ Introduction
This Registries API endpoint returns a natural person’s data from the country’s population registry. Currently, only the Lithuanian Population registry (Gyventojų registras - GR) is supported.
...
🛂 Authentication
An access token must be included in the request to access the API. You can obtain an access token by following the instructions provided here.
The API has one scope: registries_population_api, which provides access to the natural person validation endpoint.
...
☁️ Environments
The API has two environments: Sandbox and Prod. The base URLs and the available scopes for each environment are provided in the table below. Additionally, the Swagger URL for the API is also provided.
Environment | Swagger URL | Base URL | Scopes |
|---|---|---|---|
Sandbox |
| registries_population_api | |
Prod |
| registries_population_api |
...
😶🌫️ Endpoints
| Info | ||||||
|---|---|---|---|---|---|---|
/v1/natural/population |
...
🔠 Headers
Parameter | Type | Required | Description |
|---|---|---|---|
Correlation-Id | string | No | A unique identifier assigned to the request. |
Application-Id | string | YES | Your application Id. Please contact support@ondato.com you don’t have one. |
Access token | string | YES | Described in the Authentication part |
...
🎯 Request body
Field | Type | Description |
|---|---|---|
| string | National identification number of the person. Personal code (asmens kodas) in Lithuania. |
| string | Person’s document type. |
| string | Country code in ISO 3166-1 alpha-2 format. |
...
💠 Swagger
| Swagger open api macro | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
...
💳 Billing
| Info |
|---|
For billing details please contact |
...
...