post https://sandbox.boiva.id/b2b/v1/identity-verification
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 Parameters | Data Type | Description | Status |
|---|---|---|---|
| Authorization | String | Public Access Token | Mandatory |
| ktp | String | User's NIK (ID Number) to be verified against citizenship data | Mandatory |
| fullname | String | User's fullname to be verified against citizenship data | Mandatory |
| String | User's email address | Mandatory | |
| phone_number | String | User's phone number to be verified against Telco's verification data point and OTP verification | Mandatory |
| birth_date | String | User's birth date to be verified against citizenship data | Mandatory |
| birth_place | String | User's birth place to be verified against citizenship data | Additional |
| selfie_photo | String | User's selfie photo to be verified against citizenship data in Base64 format | Additional |
Notes on selfie_photo usage
The use of the selfie_foto variable will affect the billing of each API hit. If the selfie_foto field is included in the request payload, it may be counted as an additional chargeable item. For detailed information regarding pricing and billing impact, please contact our Sales team.
Response Parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| field | String | The type of field being verified through Dukcapil's data. Possible values: - fullname- ktp- birth_date- birth_place- gender (not included in the request, retrieved from Dukcapil based on KTP number)- address (not included in the request, retrieved from Dukcapil based on KTP number)- selfie_photo- selfie_liveness |
| value | String | The value of the field that is being verified through Dukcapil's data. Examples: - "Pasek Sujana" (fullname) - "1275022222222222" (ktp) - "1990-09-22" (birth_date) - "MEDAN" (birth_place) - "1" (gender: "0" for female, "1" for Male) - "Depok, KAB. SLEMAN, DAERAH ISTIMEWA YOGYAKARTA" (address |
| status | String | Indicates whether the field was successfully verified. Possible values: - true (Verified)- false (Not Verified)Note: This field is not present for selfie_liveness. |
| score | Float | The liveness detection score, applicable only for selfie_liveness. Range: 0.0 - 1.0 |
Guidelines for Selfie Verification
- Ensure there is sufficient lighting.
- Ensure your face is level with the camera, and your head is centered in the picture.
- Maintain an appropriate distance between your face and the camera—neither too far and not too close.
- Choose a plain background.
- Avoid wearing accessories that obscure your face.
- If wearing a hijab, ensure that it doesn't overly cover the forehead and cheeks.
- Make sure the person taking the selfie is the same person as the NIK data submitted.
- Only accept picture formats: jpg, jpeg, png. Maximum picture size: 5MB.
- 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.