Identity Verification Profile Object

The Identity Verification Profile object represents details for a Identity Verification (IDV) profile.

Attributes

string

ID of the IDV profile.

name

string

Name of the IDV profile.

allowedAccountTypes

array of strings, values: BUSINESS_ACCOUNT, BUSINESS_CUSTOMER, INDIVIDUAL_CUSTOMER

Types of accounts that the IDV profile can be used to verify. The following values are supported:

BUSINESS_ACCOUNT Business Account.
BUSINESS_CUSTOMER Business Customer Account.
INDIVIDUAL_CUSTOMER Individual Customer Account.

allowedAccountStatuses

array of strings

Allowed account statuses. The Business Account or Customer Account must have one of these statuses in order to be verified using the IDV profile.

minimumDocumentsRequired

map

Minimum required documents for the IDV profile. The required fields are shown for each document.

minimumInformationRequired

map

Minimum required information. The Business Account or Customer Account must contain this information in order to be verified using the IDV profile.

Identity Verification Profile Object

				
					{
  "id": "kyb-profile-1",
  "name": "KYB Profile 1",
  "allowedAccountTypes": [
    "INDIVIDUAL_CUSTOMER"
  ],
  "allowedAccountStatuses": [
    "ACTIVE"
  ],
  "minimumDocumentsRequired": {
    "passport": [
      "ISSUING_COUNTRY",
      "EXPIRY_DATE"
    ],
    "drivingLicense": [
      "ISSUING_COUNTRY",
      "EXPIRY_DATE"
    ]
  },
  "minimumInformationRequired": {
    "business": {
      "info": [
        "LEGAL_ID",
        "PRIMARY_EMAIL_ADDRESS",
        "PRIMARY_PHONE_NUMBER"
      ],
      "name": [
        "BUSINESS_LEGAL_NAME"
      ],
      "physicalAddress": [
        "LINE1",
        "CITY",
        "STATE",
        "POSTAL_CODE",
        "COUNTRY"
      ]
    },
    "beneficiary": {
      "info": [
        "DATE_OF_BIRTH",
        "SSN",
        "PRIMARY_EMAIL_ADDRESS",
        "PRIMARY_PHONE_NUMBER"
      ],
      "name": [
        "FIRST",
        "LAST"
      ],
      "physicalAddress": [
        "LINE1",
        "CITY",
        "STATE",
        "POSTAL_CODE",
        "COUNTRY"
      ]
    }
  }
}