API Reference

This API verifies User's identity based on the KTP information and will return Status of True or False based on the similarity of input to against the Citizenship data

Request Parameters

Key ParametersData TypeDescriptionStatus
AuthorizationStringPublic Access TokenMandatory
phone_numberStringUser's phone number to be verified against Telco's verification data point and OTP verificationMandatory
emailStringUser's email addressMandatory
ktpStringUser's NIK (ID Number) to be verified against citizenship dataMandatory
fullnameStringUser's fullname to be verified against citizenship dataMandatory
birth_dateStringUser's birth date to be verified against citizenship dataMandatory
selfie_photoStringUser's selfie photo to be verified against citizenship data in Base64 formatAdditional
birth_placeStringUser's birth place to be verified against citizenship dataAdditional

Response Parameters

Key ParametersData TypeDescription
fieldStringThe type of field that is being verified through Dukcapil's data

For example:

- fullname

- ktp

- selfie_photoStatus of Fields:

- Mandatory: Can't be turn off, will always need to have the value on the request.

- Additional: Can be turn on, but if it's not filled it's okay.
valueStringThe value of field that is being verified through Dukcapil's data

For example:

- John Doe (fullname)
- 1275088845132221 (ktp)
- Jane Doe (mother_maiden_name)
statusStringThe score of the field that is being verified through Dukcapil's data

For all the fields, the status will be :

- True
- False
scoreFloatThe score of this field is only for selfie liveness:

- In a score format of 0 - 1

Guidelines for Selfie Verification

  1. Ensure there is sufficient lighting.
  2. Ensure your face is level with the camera, and your head is centered in the picture.
  3. Maintain an appropriate distance between your face and the camera—neither too far and not too close.
  4. Choose a plain background.
  5. Avoid wearing accessories that obscure your face.
  6. If wearing a hijab, ensure that it doesn't overly cover the forehead and cheeks.
  7. Make sure the person taking the selfie is the same person as the NIK data submitted.
  8. Only accept picture formats: jpg, jpeg, png. Maximum picture size: 5MB.
  9. Please ensure that pictures meet the following criteria:
    Minimum height: 600px, Width: 800px
    Important Notes :
    • Please make sure subject’s face is completely within the 600x800 pixels from the center
    • Client can send photo with dimension bigger than this, but not smaller.
    • If photo received is bigger, then our system will automatically crop from the middle point of the photo.
      It will be 300px Up, 300px Down, 400px Left, and 400px Right.
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!