Certificate Issuance

The Electronic Certificate Issuance Service is the activity of identity checking that shows legal subjects in order to issue an Electronic Certificate with the purpose of doing verification of citizen

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

https://youtu.be/lA6hLFor2dcyoutu.be

Endpoints

Method

URL

POST

$synapses/v1/certificate/issuance

Headers

Header

Value

Content-Type

application/json

Authorization

Bearer YOUR_API_KEY

Request

Field

Type

Description

identityId

(required)

String(len: 16)

Nomor induk kependudukan (NIK) based on the identity card.

fullName

(required)

String

Full name based on the identity card.

birthDate (required)

String(format: yyyy-mm-dd)

Birth Date based on the identity card.

emailAddress (required)

String

Email address (must be unique per NIK).

phoneNumber (required)

String

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

faceImage

(required)

Base64

Selfie photo of the identity card holder.

Image binary encoded in base64 without <data:image/png;>. - Supports: JPG, JPEG, PNG, SVG - Min Size: 100KB - Max Size: 4MB - Min Pixel: 480px x 640px

identityImage

(required)

Base64

Identity card photo.

Image binary encoded in base64 without <data:image/png;>. - Supports: JPG, JPEG, PNG, SVG - Min Size: 100KB - Max Size: 2MB - Min Pixel: 480px x 360px

{
    "identityId": "1234567890123456",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<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.

You can use any identityId to produce verified status.

Example:

{
    "identityId": "1234567890123456",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "8c4d6927-b4e1-428b-b95f-c21b6734b73f",
        "status": "verified",
        "rejectFields": [],
        "referenceId": "ref_certel#e87c8bc2-5d10-455b-98a0-187d60f72873"
    }
}

You can use identityId =1234567890111111 to produce invalid identityId.

Example:

{
    "identityId": "1234567890111111",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "93db29c0-ca66-4803-aa70-537439c9cfff",
        "status": "not_verified",
        "rejectFields": [
            "identityId"
        ],
        "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa"
    }
}

You can use identityId =1234567890111112 to produce invalid fullName.

Example:

{
    "identityId": "1234567890111112",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "716ccf7d-4620-4146-b889-8c660cc8f280",
        "status": "not_verified",
        "rejectFields": [
            "fullName"
        ],
        "referenceId": "ref_certel#8c679bd3-087b-49f7-bdd6-3f5c6300a927"
    }
}

You can use identityId=1234567890111113 to produce invalid birthDate.

Example:

{
    "identityId": "1234567890111113",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "bba69765-371c-45ac-b673-4bb36f07ab9c",
        "status": "not_verified",
        "rejectFields": [
            "birthDate"
        ],
        "referenceId": "ref_certel#763f7342-66f6-47eb-87d2-e9a11378d911"
    }
}

You can use identityId=1234567890111114 to produce invalid face image.

Example:

{
    "identityId": "1234567890111114",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "a940e1e9-22f0-4154-8b0f-6219b417a6b1",
        "status": "not_verified",
        "rejectFields": [
            "faceImage"
        ],
        "referenceId": "ref_certel#8c946fc0-5ac2-4120-9ee5-415baf0b0e3a"
    }
}

You can use identityId=1234567890111115 to produce invalid identityImage.

Example:

{
    "identityId": "1234567890111115",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "3e37f95d-a1e8-4d89-8f0c-0f267ea0a36a",
        "status": "not_verified",
        "rejectFields": [
            "identityImage"
        ],
        "referenceId": "ref_certel#8c946fc0-5ac2-4120-9ee5-415baf0b0e2s"
    }
}

It means that the email, phone number, or both have been used by another NIK (identification number).

You can use identityId=1234567890111116 to produce invalid emailAddress.

Example:

{
    "identityId": "1234567890111116",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "368fea8e-0fad-4bc3-8ef6-fa2d8585d1d7",
        "status": "verified_with_reason",
        "rejectFields": [
            "emailAddress"
        ],
        "referenceId": "ref_certel#dfb8b449-4d83-41e8-b2f4-0343ead765f4"
    }
}

It means that the email, phone number, or both have been used by another NIK (identification number).

You can use identityId=1234567890111117 to produce invalid phoneNumber.

Example:

{
    "identityId": "1234567890111117",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "a67c4ab8-c723-49f1-a2a8-e7a579df94f7",
        "status": "verified_with_reason",
        "rejectFields": [
            "phoneNumber"
        ],
        "referenceId": "ref_certel#a704a3ad-1986-4897-975e-16e015d88b2e"
    }
}

It means that the email, phone number, or both have been used by another NIK (identification number).

You can use identityId=1234567890111118 to produce invalid Email Address & phoneNumber.

Example:

{
    "identityId": "1234567890111118",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "d35484cc-7f49-4d23-8fdd-3052fd96c8b6",
        "status": "verified_with_reason",
        "rejectFields": [
            "phoneNumber",
            "emailAddress"
        ],
        "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa"
    }
}

Failed because of liveness check, only liveness will be charged

You can use identityId=1234567890111119 to produce liveness error.

Example:

{
    "identityId": "1234567890111119",
    "fullName": "ASEP SUPRIYADI",
    "birthDate": "1990-07-06",
    "emailAddress": "test@email.com",
    "phoneNumber": "621234567890",
    "faceImage": "<base64>",
    "identityImage": "<base64>"
}

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "36a6ed7b-cd7a-44d7-b4d2-d181cf561ea3",
        "status": "not_verified",
        "rejectFields": [
            "liveness_check"
        ],
        "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa"
    }
}

Response

Field

Type

Description

String

Kredibel history id (unique for every transactions).

status

String

Identifier of the transaction status:

- verified

- verified_with_reason

- not_verified

rejectFields

Array

Indicator if there’s a false response to a or any parameter, example if nik.

referenceId

String

Reference id.

{
    "message": "Certificate electronic verification has been done",
    "data": {
        "id": "8c4d6927-b4e1-428b-b95f-c21b6734b73f",
        "status": "verified",
        "rejectFields": [],
        "referenceId": "ref_certel#e87c8bc2-5d10-455b-98a0-187d60f72873"
    }
}

Errors

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

PreviousElectronic Certificate NextIdentity Verification [Deprecated]

Last updated 2 years ago