Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents

ℹ️ Introduction

...

The API has one scope: registries_population_api, which provides granting access to the natural person validation endpoint.

...

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

https://sandbox-registries.ondato.com/swagger/index.html

https://sandbox-registries.ondato.com

registries_population_api

Prod

https://registries.ondato.com/swagger/index.html

https://registries.ondato.com

registries_population_api

😶‍🌫️ Endpoints

...

📍 Endpoint

Panel
bgColor#E3FCEF

Status
colourGreen
titlePOST
/v1/natural/population

...

Parameter

Type

Required

Description

Correlation-Id

stringNo

Status
titleno

A unique identifier assigned to the request.

Application-Id

string

Status
YES
titleyes

Your application Id.

Please contact support@ondato.com you don’t have one.

Access token

string

Status
title
YES
yes

Described in the Authentication part.

...

🎯 Request body

Field

Type

Description

personalCode

string

National identification number of the person. Personal code (asmens kodas) in Lithuania.
Examples (sandbox):
50001018865
38710079999
38505019999

documentType

string

Person’s document type.
Optional parameter. If it is not provided then data is returned of the last issued document ignoring the type.

countryCode

string

Country code in ISO 3166-1 alpha-2 format.
Example: LT for Lithuania

...

💳 Billing

Info

For billing details, please contact billing@ondato.com.

...