VEverihubs
Sandbox - National ID Service

Sandbox - National ID Service

This method helps you to perform identity checking that shows legal subjects in order to issue an Electronic Certificate with the purpose of doing verification of citizenship data through legal sources.

Scenario Description

ScenarioRequest PayloadDescription
User input all valid dataNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDData inputted based on rules & registered in Dukcapil based on NIK
User input real valid NIK integers format16 DIGITS NUMERIC <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDNIK with the following suffix will give effect to the given image <br> "003" :"IMAGE_NO_FACE" <br> "004" :"IMAGE_INVALID" <br> "005" :"IMAGE_INVALID_2" <br> "006" :"IMAGE_INVALID_3" <br> "007" :"IMAGE_EXCEED_LIMIT_SIZE" <br> "008" :"IMAGE_UNDER_LIMIT_SIZE"
User input invalid NIK formatNIK_INVALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDInputted invalid NIK format
User inputs NIK more than 16 digit numbersNIK_INVALID_2 <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDNIK > 16 digits numeric
User inputs NIK less than 16 digit numbersNIK_INVALID_3 <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDNIK < 16 digits numeric
User inputs NIK with special charactersNIK_INVALID_4 <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDInputted NIK is not in numeric format
User did not input NIKNIK_EMPTY <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input only NIK
User did not input payload NIKNIK_NONE <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input payload NIK
User inputs invalid nameNIK_VALID <br> NAME_INVALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDName inputted is not registered in Dukcapil accordance NIK
User did not input nameNIK_VALID <br> NAME_EMPTY <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input only name
User did not input payload nameNIK_VALID <br> NAME_NONE<br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input payload name
User inputs invalid birth dateNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_INVALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDBirth date inputted is not registered in Dukcapil accordance NIK
User inputs valid birth date with other formatNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_INVALID_2 <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDBirth date inputted is not accordance with the Birth Date Format, Should be DD-MM-YYYY
User did not input birth dateNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_EMPTY <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input only birth date
User did not input payload birth dateNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_NONE <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_VALIDDid not input payload birth date
User inputs invalid emailNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_INVALID <br> PHONE_VALID <br> IMAGE_VALIDInputted invalid email
User did not input emailNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_EMPTY <br> PHONE_VALID <br> IMAGE_VALIDDid not input only email
User did not input payload emailNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_NONE <br> PHONE_VALID <br> IMAGE_VALIDDid not input payload email
User inputs invalid phoneNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_INVALID <br> IMAGE_VALIDInputted invalid phone format
User did not input phoneNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_EMPTY <br> IMAGE_VALIDDid not input only phone
User inputs phone less than 7 digits numbersNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_INVALID_2 <br> IMAGE_VALIDPhone < 7 digits numeric
User inputs phone more than 20 digits numbersNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_INVALID_3 <br> IMAGE_VALIDPhone > 20 digits numeric
User did not input payload phoneNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_NONE <br> IMAGE_VALIDDid not input payload phone
User inputs valid image but different person with NIKNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_INVALIDImage inputted with format base64 or identity image URL but different person accordance to NIK
User inputs invalid image format dimensionNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_INVALID_2Image inputted with another format (not in a vallid base64 or url)
User inputs invalid image format dimensionNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_INVALID_3Image inputted with under 400px*400px dimension
User inputs image but no face photoNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_NO_FACEImage inputted with format base64 or identity image URL but no face photo
User inputs invalid image with size more than 2 MBNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_EXCEED_LIMIT_SIZEImage size > 2 MB with 400px * 400px
User inputs invalid image with size less than 30 KBNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_UNDER_LIMIT_SIZEImage size < 30 KB with 400px * 400px
User did not input imageNIK_VALID <br> NAME_VALID <br> BIRTH_PLACE_VALID <br> BIRTH_DATE_VALID <br> IMAGE_EMPTYDid not input only image
User did not put payload imageNIK_VALID <br> NAME_VALID <br> BIRTH_DATE_VALID <br> EMAIL_VALID <br> PHONE_VALID <br> IMAGE_NONEDid not put payload image
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

Headers

App-IDstring required
API-Keystring required

Request body

nikstring required

16 digit numeric Identifier Number from ID.

namestring required

Full name from ID.

birth_datestring required

Date of birth from ID in DD-MM-YYYY format.

emailstring required

Email address (must be unique per nik).

phonestring required

Valid phone number, use country code but without symbol (+), (must be unique per nik).

imagestring required

Selfie photo in base64 format, size min. 30 kB max. 2 MB, min pixel 400px x 400px

Response

Successful Response

codeinteger required

Code (to be deleted on November 30, 2022)

statusinteger required

Status (to be deleted on November 30, 2022)

messagestring required

Message

Example response

{
  "code": 200,
  "message": "ID has been checked"
}

Changes

No recorded changes to this operation across all 1 revision of this API.