Introducing VIDA Identity Stack: All of VIDA, in one place 🎉
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Demographic Verification

This configuration performs demographic-only verification by validating submitted personal details such as full name, national ID number, date of birth, and place of birth. While the request also includes biometric input like a selfie, only the demographic information is processed and evaluated. This model supports use cases where biometric verification is managed separately by the client or an authorized registration authority.

Parameters

Field
Type
Description
Sample Value

partnerTrxId*

string

Generate a unique transaction ID in UUID format and include it in the request to link your transaction with the VIDA transaction.

Generated random UUID by the partner.

Example:

1000073-c00f-4008-8005-d2ec4d9be956

groupId

string

For each NIK, partners should send a unique group ID that can be used to track related transactions across multiple fraud assessment categories.

This is mandatory for customers using Multistage verification

Generated random UUID by the partner.

Example:

8000073-d00e-9008-9005-d2ce4b9ce956

transactionType*

string

Type of the transaction

In the demographic verification below transaction type is applicable: DATA_FRAUD_ASSESSMENT

govId*

string

The user's government ID number

Example: (NIK - Nomor Induk Kependudukan), consisting of a 16-digit number: 3451222123456716

govIdType

string

The type of IDCard Document.

Supported values “KTP"

fullName*

string

Users Full Name which should same with registered ID

User full name as per KTP.

example: Johnny Rudiantara Sembiring

dob*

string

User's Date of Birth

Date of Birth in yyyy-mm-dd format 1989-01-01

mobile*

string

The user's verified mobile number with the country code, provided in E.164 format without spaces or special characters.

Example: +6281293671234.

If the mobile number isn’t available, a verified email address can be passed, however, one of the two is mandatory

email

string

The user's valid email address

Example: user@example.com

consent*

object

A user’s consented timestamp value where they agreed to consent sharing data with VIDA

"consent": {

"consentedAt": "1614089870",

"consentGiven": true

}

idCardPhoto

base64-encoded string

A plain base64-encoded string of the user ID card Photo (i.e. KTP)

Example: "/9j/4AAQSkZJRgABAQAAJAAkAAD/4QhcR..."

selfiePhoto*

base64-encoded string

A base64-encoded string of the user's selfie for facial recognition and face-match checks, adhering to specified image standards.

Example: "/9j/4AAQSkZJRgABAQAAJAAkAAD/4QhcR..."

*required

Extended Demographic Parameters

Extended demographic parameters refer to additional identity-related fields that go beyond the standard personal information typically used in identity verification. These may include data such as address, nationality, gender, marital status, mother’s maiden name, and family card number. Including extended parameters can enhance the accuracy of verification, support higher assurance levels, or fulfill regulatory and business requirements for more detailed profiling.

Field
Type
Description
Sample Value

pob

string

User's Place of Birth

Jakarta

motherMaidenName

string

The user's mother’s maiden name as per IDCard.

Siti Elizabeth

gender

string

The user's gender

Laki-Laki

occupation

string

The user's listed occupation

Petani

maritalStatus

string

The user's marital status as per IDCard.

Belum Kawin

familyCardNo

string

The user's family card number (if idCardType is KTP)

3451222123456716

address

string

The user's residential address as per KTP (Alamat).

Jl. Pasti Cepat A7/66

village

string

The user's residential village as per KTP (Kelurahan/Desa).

Pegadungan

villageCode

string (4 digit)

The user's residential village code (Kelurahan/Desa).

1001

district

string

The user's residential district as per KTP (Kecamatan).

Kalideres

districtCode

string (2 digit)

The user's residential district code (Kecamatan).

10

city

string

The user's city of residence as per KTP (Kabupaten/Kota)

Jakarta Barat

cityCode

string (2 digit)

The user's city code of residence (Kabupaten/Kota)

13

province

string

The user's province of residence as per KTP (Provinsi).

DKI Jakarta

provinceCode

string (2 digit)

The user's province code of residence (Provinsi).

23

Sample Request

Sample Request (Main Parameters Only)
Sample Request (With Extended Demog)

Sample Response

HTTP Status Code: 200

JSON Response

Sample Response (Main Parameters Only)
Sample Response (With Extended Demog)

Sample Response Value Explanation

Parameters
Description

full_name

Degree of match between the provided full name and stored data.

dob

Degree of match between the provided date of birth (DOB) and stored data.

fraudAssessment

Indicates whether the fraud assessment process is completed.

authenticationLevel

Assurance level of the authentication process. authenticationLevel field should not be used programatically to determine a successful transaction. Instead, customer should define successful transaction based on Status Check API, score & fraudAssessment status

certificate

Details regarding the certificate's trustworthiness for digital signatures.

groupId

Returned only for Multistage Verification. The groupId passed on the request body

1. Accept Responses

HTTP Status Code: 200

Status : SUCCESS

Main Parameters

JSON Response

Extended Demography Parameters

JSON Response

motherMaidenName as Additional Parameter

JSON Response

2. Reject Responses

HTTP Status Code: 200

Status : SUCCESS

Demographic Parameters

JSON Response

Extended Demographic Parameters

JSON Response

3. Error Responses

3.1 Required parameters are missing

This error occurs when one or more mandatory fields are not provided in the request. The response includes details of the missing parameter in the detail field.

HTTP Status Code: 400

Status : ERROR

JSON Response

Last updated