DocDatabaseDetail

DocDatabaseDetail

Field

Description

bvn

string, The bvn that passed the verification. The format is an 11-digit number starting with 22, such as (221xxx22222).

numberValue

string, The number that passed the verification.

numberTypeInfo

object, The number type info of the numberValue.

firstName

string, The first name.

middleName

string, The middle name.

lastName

string, The last name.

fullName

string, The fullName.

gender

string, MALE or FEMALE.

birthday

string, The birthday. Format:yyyy/MM/dd.

phoneNumber

string, The phone number.

phoneNumber2

string, The second phone number.

email

string,The email.

verification

object, The verification details.

aadhaarDetail

object, The adhaar verification details.

panDetail

object, The permanent account verification details.

cpfStatus

enum, Regular/Holder's Death/Suspended/Not exist

motherName

string,The name of mother.

address

object,The address.


Examples

{
  "bvn": "22********4",

  "numberValue": "22********4",
  "numberTypeInfo": {
    "numberType": "NG_BVN",
    "region": "NGA"
  },
  "firstName": "T****E",
  "middleName": "C****T",
  "lastName": "I***A",
  "gender": "FEMALE",
  "birthday": "1994/07/13",
  "phoneNumber": "081******05",
  "phoneNumber2": "",
  "email": null,
  "verification": {
    "numberValue": null,
    "fullName": null,
    "dob": null,
    "face": null
  }
}
{
  "bvn": null,
  "nin": null,
  "numberValue": "************0005",
  "numberTypeInfo": {
    "numberType": "ID_NIK",
    "region": "IDN"
  },
  "firstName": null,
  "middleName": null,
  "lastName": null,
  "fullName": "R**** I**********",
  "gender": "FEMALE",
  "birthday": "1976/**/**",
  "phoneNumber": "+62*******4455",
  "phoneNumber2": null,
  "email": "w*****c@***.com",
  "verification": {
    "numberValue": "pass",
    "fullName": "fail",
    "dob": "fail",
    "face": "fail"
  }
}
{
        "numberTypeInfo": {
                "numberType": "IN_AADHAAR_PAN",
                "region": "IND"
        },
        "aadhaarDetail": {
                "maskedAadhaar": "22********4",
                "fullName": "",
                "gender": "FEMALE",
                "birthday": "1994/07/13",
                "address": {
                    "country": "India",
                    "dist": "New Delhi",
                    "state": "Delhi",
                    "po": "Connaught Place",
                    "house": "12B",
                    "loc": "Central Delhi",
                    "vtc": "Connaught Place",
                    "subdist": "New Delhi",
                    "street": "Main Road",
                    "landmark": "Near Metro Station"
                }
        },
        "panDetail": {
                "pan": "",
                "fullName": "",
                "gender": "FEMALE",
                "birthday": "1994/07/13",
                "aadhaarLinked": true/false/null
        }
}
{
    "numberValue": "078.734.383-84",
    "numberTypeInfo": {
        "numberType": "BR_CPF",
        "region": "BRA"
    },
    "fullName": "GLEICIANE RODRIGUES DA SILVA",
    "gender": "FEMALE",
    "birthday": "1999/12/26",
    "cpfStatus": "Regular",
    "motherName": "ALDAIZA RODRIGUES DA SILVA",
    "address": {
        "number": "SN",
        "city": "ARACOIABA",
        "street": "COMENDADOR EUGENIO CASTRO SILVA",
        "postalCode": "62750000",
        "neighborhood": "CENTRO",
        "state": "CE",
        "type": "residential"
    },
    "verification": {
        "numberValue": null,
        "fullName": null,
        "dob": null,
        "face": "pass"
    }
}

DocDatabaseDetail.numberTypeInfo

FieldDescription
regionRefer to Supported Regions & NumberTypes
numberTypeRefer to Supported Regions & NumberTypes

DocDatabaseDetail.verification

FieldDescription
numberValuestring. VerificationResult of numberValue. Refer to verificationResult
fullNamestring. VerificationResult of fullName. Refer to verificationResult
dobstring. VerificationResult of dob. Refer to verificationResult
facestring. VerificationResult od face. Refer to verificationResult

verificationResult

ValueExplain
nullthe datasource doesn't tell this field's verificationResult.
passthis field passed datasource check.
failthis field failed datasource check.

DocDatabaseDetail.aadhaarDetail


FieldDescription
maskedAadhaarstring. Masked aadhaar
fullNamestring. The full Name.
genderstring, MALE or FEMALE.
birthdaystring, The birthday. Format:yyyy/MM/dd.
addressobject, The address Details.

DocDatabaseDetail.aadhaarDetail.address


FieldDescription
countrystring. The country of the address.
statestring. First-level administrative division.
diststring. Second-level administrative division.
subdiststring. Third-level administrative division (Tehsil/Taluk).
vtcstring. Village / Town / City The specific village, town, or city of residence.
locstring. A recognizable area or neighborhood within a city.
postring. The name of the local post office serving the area.
streetstring. The name of the street.
housestring. House number or building identifier.
landmarkstring. nearby well-known reference point for locating the address.

DocDatabaseDetail.panDetail

FieldDescription
panstring. permanent account number.
fullNamestring. The full Name.string. The full address.
genderstring, MALE or FEMALE.
birthdaystring, The birthday. Format:yyyy/MM/dd.
aadhaarLinkedbool, true/false/null. if the pan is linked with addhaar.

DocDatabaseDetail.address

FieldDescription
numberstring, The house or building number.
postalCodestring, The postal code (CEP) in Brazil, an 8-digit code.
citystring, The city name.
streetstring, The street name.
neighborhoodstring, The neighborhood or district (bairro).
statestring, The state abbreviation.
typestring, The address type.