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
Request
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
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.
You can use identityId = 1234567890123456 to produce face not match result.
Example:
You can use any identityId except 1234567890123456 to produce identity not valid result.
Example:
You can use identityId=1234567890123451 to produce full name is not valid.
Example:
You can use identityId=234567890123452 to produce address is not valid.
Example:
You can use identityId=234567890123453 to produce birth place is not valid.
Example:
You can use identityId=234567890123454 to produce birth date is not valid.
Example:
Response
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.
Errors
Please read this page <Responses & Errors> to know more about response.
Error 4XX
request_error
Cannot get response from Dukcapil server.
False
In general, the error response structure is as below:
Error 5XX
For every 5XX http code response, there will be no charge.
Last updated