---
title: "National ID Service"
method: POST
path: "/v1/id/check"
tags: ["National ID Service"]
---

# National ID Service

`POST /v1/id/check`

## Request

- Base URL: `https://api.verihubs.com`
- URL: `https://api.verihubs.com/v1/id/check`
- Auth: none declared. Required headers: `App-ID`, `API-Key`

This method helps you to perform identity checking through legal sources.

## Headers

- `App-ID` string, required
- `API-Key` string, required

## Request body

- IdCheck
  - `nik` string, required: 16 digit numeric Identifier Number from ID.
  - `name` string, required: Full name from ID.
  - `birth_date` string, required: Date of birth from ID in DD-MM-YYYY format.
  - `email` string, required: Email address (must be unique per nik).
  - `phone` string, required: Valid phone number, use country code but without symbol (+), (must be unique per nik).
  - `image` string, required: Selfie photo in base64 format, size min. 30 kB max. 2 MB, min pixel 400px x 400px.

## Response `200`

Successful Response

- ResponseIdCheck
  - `code` integer, required: Code **(to be deleted on November 30, 2022)**
  - `status` integer, required: Status **(to be deleted on November 30, 2022)**
  - `message` string, required: Message
  - `results` object, required: Shows results of ID
    - `nik` string: it will return "Registered or Not Registered". if Nik is not registered all the key; name, birthdate, birthplace, address will return null
    - `name` boolean: it will return 'true' or 'false'based on individual name that registered on ektp.
    - `birth_date` boolean: it will return 'true' or 'false'based on individual birth date that registered on ektp.
    - `email` string
    - `phone` string
    - `similarity` integer: it will return a percentage of similarity '0-100'

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/verihubs/apis/data-api-documentation.md) - [All operations](https://skmtc.dev/verihubs/apis/data-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/verihubs/apis/data-api-documentation/revisions/85f2e8ecf82d?raw)