Demography Verification

Demography verification to dukcapil database.

This module only support biometric verification for indonesian identity card (KTP)

Endpoints

Method	URL
POST	$synapses/v1/identity/verification/demography

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer YOUR_API_KEY

Request

Description

Field	Type	Description
identityId (required)	String (len: 16)	Nomor induk kependudukan (NIK).
fullName (optional)	String	Full name.
birthPlace (optional)	String	Birth Place.
birthDate (optional)	String (format: yyyy-mm-dd)	Birth Date.
address (optional)	String	Address.
threshold (optional)	Float (0-1)	Matched threshold for demography data (fullName, birthPlace, address) - 0=0% match, 0.5=50% match, 1=100% match

Example

{
    "identityId": "1234567890123456",
    "faceImage": "<base64>"
}

Testing

In the sandbox environment, we only response api call with dummy data. To get valid response data, you can use our production environment instead.

All Match

You can use identityId = 1234567890123456 to produce face not match result.

Example:

{
    "identityId": "1234567890123456",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "43ad6108-a5ce-452f-8603-d60d24c2ef3e",
        "identityId": "1234567890123456",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": true,
            "fullNameSimilarity": 1.0,
            "address": true,
            "addressSimilarity": 1.0,
            "birthPlace": true,
            "birthPlaceSimilarity": 1.0,
            "birthDate": true
        }
    }
}

Wrong Identity

You can use any identityId except 1234567890123456 to produce identity not valid result.

Example:

{
    "identityId": "1234567890123450",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "c1fa0289-b6ea-4ffe-9d05-10fd99143ad5",
        "identityId": "1234567890123450",
        "isValid": false,
        "isActive": false,
        "response": {}
    }
}

Wrong Name

You can use identityId=1234567890123451 to produce full name is not valid.

Example:

{
    "identityId": "1234567890123451",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "673a9284-87e9-4f08-bb08-b820844b6159",
        "identityId": "1234567890123451",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": false,
            "fullNameSimilarity": 0.43,
            "address": true,
            "addressSimilarity": 1.0,
            "birthPlace": true,
            "birthPlaceSimilarity": 1.0,
            "birthDate": true
        }
    }
}

Wrong Address

You can use identityId=234567890123452 to produce address is not valid.

Example:

{
    "identityId": "1234567890123452",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "be99966d-597c-4da9-a475-83392ef899f4",
        "identityId": "1234567890123452",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": true,
            "fullNameSimilarity": 1.0,
            "address": false,
            "addressSimilarity": 0.58,
            "birthPlace": true,
            "birthPlaceSimilarity": 1.0,
            "birthDate": true
        }
    }
}

Wrong Birthplace

You can use identityId=234567890123453 to produce birth place is not valid.

Example:

{
    "identityId": "1234567890123453",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "4faf35f4-44a1-47b2-8a18-07d243174aba",
        "identityId": "1234567890123453",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": true,
            "fullNameSimilarity": 1.0,
            "address": true,
            "addressSimilarity": 1.0,
            "birthPlace": false,
            "birthPlaceSimilarity": 0.23,
            "birthDate": true
        }
    }
}

Wrong Birthdate

You can use identityId=234567890123454 to produce birth date is not valid.

Example:

{
    "identityId": "1234567890123454",
    "fullName": "ASEP SUPRIYADI",
    "address": "JL SESAMA NO 123",
    "birthPlace": "JAKARTA",
    "birthDate": "1990-07-06"
}

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "41272ecf-b5e2-4897-a492-b89356fab0c2",
        "identityId": "1234567890123454",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": true,
            "fullNameSimilarity": 1.0,
            "address": true,
            "addressSimilarity": 1.0,
            "birthPlace": true,
            "birthPlaceSimilarity": 1.0,
            "birthDate": false
        }
    }
}

Response

Description

Field	Type	Description
id	String	Unique identifier.
identityId	String	Nomor induk kependudukan (NIK).
isValid	Boolean	Return true if identityId is exist in the Dukcapil database.
isActive	Boolean	Return true if identityId is active in the Dukcapil database.
response:fullName	Boolean	Return true if input fullName match with the fullName in Dukcapil database.
response:fullNameSimilarity	Float (0-1)	Similarity between the input fullName and the fullName in Dukcapil database.
response:address	Boolean	Return true if input birth date match with the birth date in Dukcapil database.
response:addressSimilarity	Float (0-1)	Similarity between the input address and the address in Dukcapil database.
response:birthPlace	Boolean	Return true if input birth place match with the birth place in Dukcapil database.
response:birthPlaceSimilarity	Float (0-1)	Similarity between the input birthPlace and the birthPlace in Dukcapil database.
response:birthDate	Boolean	Return true if input birth date match with the birth date in Dukcapil database.

Example

{
    "message": "Identity demography verification succeeded.",
    "data": {
        "id": "948cc6f9-1662-4ae7-a578-fdaa50331507",
        "identityId": "1234567890123456",
        "isValid": true,
        "isActive": true,
        "response": {
            "fullName": true,
            "fullNameSimilarity": 1.0,
            "address": true,
            "addressSimilarity": 1.0,
            "birthPlace": true,
            "birthPlaceSimilarity": 1.0,
            "birthDate": true
        }
    }
}

Errors

Please read this page <Responses & Errors> to know more about response.

Error 4XX

Error Type

Error Type	Description	Is charged?
request_error	Cannot get response from Dukcapil server.	False

Structure

In general, the error response structure is as below:

{
   "errors":{
      "errorId": <log_id:uuid>,
      "errorType": <error_type:str>
   },
   "message": <message:str>
}

Error 5XX

For every 5XX http code response, there will be no charge.