Signer is not verified by VIDA

Important: The content of this page is only applicable if the client does NOT use VIDA full verification.

To be able to use Registration API, the client has to undergo Registration Authority Assessment. Please contact VIDA team for more details

Description

If the client already has an existing authoritative source connection to verify the signers — for example: direct connection or existing KYC provider — the client can use Registration API to register the pre-verified signer.

The usage of this API is strictly defined by Registration Authoritity assessment & agreement. Please contact VIDA team for more details.

1. The API below will generate an identifier registrationId for the pre-verified user, which will be used for DirectSign digital signature using Komdigi-rooted certificate.

2. After a successful Registration, please refer to Create Envelope with Document Upload for signing document using DirectSign API

---

API Authentication

Please refer to API Authentication for getting API Token access

---

Registration API

API Endpoint

POST https://{{environment_url}/main/v2/services/ra

Request Body

{
    "partnerTrxId": "UUID",  
    "mobile": "[phone]", 
    "email": "[e-mail]",
    "govId": "3511001234567890",
    "govIdType": "KTP",
    "fullName": "John Doe",
    "dob": "1995-01-21",
    "selfiePhoto": "<base64 of Selfie image>",
    
    "idCardPhoto": "<base64 of ID card image>",
    "motherMaidenName": "TestMMN",
    "pob": "TestPOB",
    "address": "TestAddress",
    "village": "TestVillage",
    "district": "TestDistrict",
    "city": "TestCity",
    "province": "TestProvince",
    "consent": {
        "consentedAt": "{{today}}",
        "consentGiven": true
    }
}

Name	Type	Mandatory?	Description
partnerTrxId	String	Yes	Client-provided unique signer identifier This identifier should ideally be kept the same with the client's own user identifier. partnerTrxId will be used to in Get Registration IDGet Transaction DetailsAPI
mobile	String	Yes	The signer's phone number Format:
email	String	Yes*	The signer's email address If the client do verify the signer's email address, then this field is mandatory. Otherwise, this field should be left blank
govId	String	Yes	The signer's government ID / NIK
govIdType	String	Yes	The government ID type (eg: KTP)
fullName	String	Yes	The signer's full name
dob	String	Yes	The signer's date of birth
selfiePhoto	String	Yes	The signer's liveness-accepted selfie photo Base64 of XXX file extension Minimum size: Maximum size:
idCardPhoto	String	No	The signer's ID Card photo Base64 of XXX file extension Minimum size: Maximum size:
motherMaidenName	String	No	The signer's mother maiden name
pob	String	No	The signer's place of birth
address	String	No	The signer's address
village	String	No	The signer's village address
district	String	No	The signer's district address
city	String	No	The signer's city address
province	String	No	The signer's province address
consent	Array	Yes	Consent collection
consent.consentedAt	String	Yes	The timestamp (in epoch) of when the user's consent is collected
consent.consentGiven	Boolean	Yes	Consent status (true)

Response Body

Success

{
    "data": {
        "registrationId": "004646b4-879e-4b99-90d6-1cc21c713891"
    }
}

---

Get Registration ID

API Endpoint

GET https://{{environment_url}/main/v2/services/ra/<partnerTrxId>/user

Response Body

Success

{
    "data": {
        "partnerTrxId": "Test123",
        "registrationId": "004646b4-879e-4b99-90d6-1cc21c713812"
    }
}

---

Get Transaction Details

API Endpoint

GET https://{{environment_url}/main/v2/services/ra/<partnerTrxId>/transaction-detail

Response Body

Success

{
    "data": {
        "registrationId": "UUID",  
        "mobile": "[phone]", 
        "email": "[e-mail]",
        "govId": "3511001234567890",
        "govIdType": "KTP",
        "fullName": "John Doe",
        "dob": "1995-01-21",
        "selfiePhoto": "<base64 of Selfie image>",
        "idCardPhoto": "<base64 of ID card image>",
        "motherMaidenName": "TestMMN",
        "pob": "TestPOB",
        "address": "TestAddress",
        "village": "TestVillage",
        "district": "TestDistrict",
        "city": "TestCity",
        "province": "TestProvince",
        "consent": {
            "consentedAt": "{{today}}",
            "consentGiven": true
        }
    }
}

---

Verify by Submitting

Request - Without Mobile Number

"{
    ""errors"": [
        {
            ""code"": 1006,
            ""title"": ""mobile"",
            ""detail"": ""Must not be blank""
        }
    ]
}"

Request - Without DOB

"{
    ""errors"": [
        {
            ""code"": 1006,
            ""title"": ""dob"",
            ""detail"": ""must not be null""
        }
    ]
}"

Request - Without FullName

{
    "errors": [
        {
            "code": 1006,
            "title": "fullName",
            "detail": "must not be blank"
        }
    ]
}

Request - Without Consent

"{
    ""errors"": [
        {
            ""code"": 1006,
            ""title"": ""consent"",
            ""detail"": ""Invalid Consent field""
        }
    ]
}"

Request - Without Selfie

"{
    ""errors"": [
        {
            ""code"": 1006,
            ""title"": ""selfiePhoto"",
            ""detail"": ""must not be blank""
        }
    ]
}"

Request - Without Gov ID

"{
    ""errors"": [
        {
            ""code"": 1006,
            ""title"": ""govId"",
            ""detail"": ""Invalid GovId""
        }
    ]
}"

Verify if User Exists

fullName has changed

"{
    ""errors"": [
        {
            ""code"": 4501,
            ""title"": ""User update failed. Modification of the user's dob/fullName is not permitted."",
            ""detail"": ""Cannot update user '06db127f-bd42-5866-b5d3-707bba67d20a' due to changes in certificate attributes (fullName/dob)""
        }
    ]
}"

DOB has changed

"{
    ""errors"": [
        {
            ""code"": 4501,
            ""title"": ""User update failed. Modification of the user's dob/fullName is not permitted."",
            ""detail"": ""Cannot update user '06db127f-bd42-5866-b5d3-707bba67d20a' due to changes in certificate attributes (fullName/dob)""
        }
    ]
}"

FullName, Email has changed

"{
    ""errors"": [
        {
            ""code"": 4501,
            ""title"": ""User update failed. Modification of the user's dob/fullName is not permitted."",
            ""detail"": ""Cannot reregister user due to changes in certificate attributes (fullName/dob)""
        }
    ]
}"

FullName, MMN has changed

"{
    ""errors"": [
        {
            ""code"": 4501,
            ""title"": ""User update failed. Modification of the user's dob/fullName is not permitted."",
            ""detail"": ""Cannot reregister user due to changes in certificate attributes (fullName/dob)""
        }
    ]
}"

Check external RA user

"{
    ""errors"": [
        {
            ""code"": 1000,
            ""title"": ""An error occurred while processing request"",
            ""detail"": """"
        }
    ]
}"

Check VIDA RA user

"{
    ""errors"": [
        {
            ""code"": 1000,
            ""title"": ""An error occurred while processing request"",
            ""detail"": """"
        }
    ]
}"