List Identity Verification Profiles

Retrieve a list of Identity Verification (IDV) profiles that a specific Business Account can use to submit an IDV application. IDV profiles will be retrieved for the Business Account associated with the request access token.

You can retrieve all profiles or use the identityAccountTypes query parameter to retrieve a specific type of profile.

Endpoint

GET /v1/identity-verification-profiles

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

identityAccountTypes

string enum, 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.

Request Body

None

Returns

Returns a list of Identity Verification Profile objects.

SAMPLE RESPONSE

				
					[
  {
    "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"
        ]
      }
    }
  },
  {...},
  {...}
]