Retrieve an Identity Verification Application

Retrieve an Identity Verification (IDV) application that has been submitted for a Business Account or Customer Account.

Endpoint

GET /v1/identity-verifications/{applicationId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

applicationId  REQUIRED

string (UUID)

ID of the IDV application.

Request Body

None

Returns

Returns the Identity Verification Application object. This object contains the IDV application details.

SAMPLE RESPONSE

				
					{
  "id": "56de0668-7ae5-4706-8591-cd674c512267",
  "businessAccountId": "dac207b6-eb7b-4080-b786-6e505443e26d",
  "accountId": "93813d7a-b333-4701-8d05-a2b4218da883",
  "identityVerificationProfileId": "kyc-profile-1",
  "firstName": "James",
  "lastName": "Smith",
  "legalName": "",
  "accountType": "INDIVIDUAL_CUSTOMER",
  "latestStatus": "COMPLETED",
  "outcome": "Approved",
  "statusHistory": [
    {
      "id": "9972f30f-13eb-414f-8830-f198d5ef29c0",
      "status": "NEW",
      "message": "event_validated",
      "createdAt": "2023-08-09T21:16:37.250Z",
      "updatedAt": "2023-08-10T21:16:37.250Z",
      "outcome": "Approved"
    },
    {...},
    {...}
  ],
  "metadata": {
    "key1": "value1"
  },
  "completedAt": "2023-08-10T21:16:37.250Z",
  "createdAt": "2023-08-09T21:16:37.250Z",
  "createdBy": {
    "id": "48a64999-3222-496d-b6c4-1c019f1059d6",
    "type": "employee"
  },
  "updatedBy": {
    "id": "48a64999-3222-496d-b6c4-1c019f1059d6",
    "type": "employee"
  },
  "updatedAt": "2023-08-10T21:16:37.250Z",
  "entities": [
    {
      "accountId": "93813d7a-b333-4701-8d05-a2b4218da883",
      "firstName": "James",
      "lastName": "Smith",
      "legalName": "",
      "entityType": "INDIVIDUAL_CUSTOMER",
      "status": "COMPLETED",
      "outcome": "APPROVED",
      "outcomeDetails": [
        {
          "outcomeReasons": [
            {
              "name": "Phone match",
              "type": "Fraud check"
            }
          ],
          "tags": [
            "Phone number matched"
          ]
        }
      ],
      "statusHistory": [
        {
          "id": "9972f30f-13eb-414f-8830-f198d5ef29c0",
          "status": "NEW",
          "message": "event_validated",
          "createdAt": "2023-08-09T21:16:37.250Z",
          "updatedAt": "2023-08-10T21:16:37.250Z",
          "entityId": "aa148ff5-057d-4291-a4d5-133d9994d384"
        },
        {...},
        {...}
      ],
      "processingSummary": {
        "ADDRESS.CITY": "Chicago",
        "INFO.PRIMARY_PHONE_NUMBER": "123232333",
        "DOCS.PASSPORT": "ef2403f1-e350-4db9-b289-0c1e741be3d1"
      },
      "docUploadUrl": "",
      "createdAt": "2023-08-28T21:45:39.335Z",
      "createdBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "employee"
      },
      "updatedBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "employee"
      },
      "updatedAt": "2023-08-28T21:45:39.335Z"
    }
  ]
}
				
			
Exit mobile version