List Identity Verification Applications

Retrieve all Identity Verification (IDV) applications submitted by a Business Account. IDV applications will be retrieved for the Business Account associated with the request access token.

Use the query parameters to filter the results. Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.

Endpoint

GET /v1/identity-verifications

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

createdDateFrom

string (date), format: yyyy-MM-dd

Date the IDV application was created in the RocketKOR system. This filter will return applications created on or after this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

createdDateTo

string (date), format: yyyy-MM-dd

Date the IDV application was created in the RocketKOR system. This filter will return applications created on or before this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

completedDateFrom

string (date), format: yyyy-MM-dd

Date the IDV application was completed. This filter will return applications completed on or after this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

completedDateTo

string (date), format: yyyy-MM-dd

Date the IDV application was completed. This filter will return applications completed on or before this date.

Note The date is interpreted using the specified timeZone. UTC format is used if timeZone is not provided.

timeZone

string (timeZone), default value: UTC

Time zone for the createdDateFrom, createdDateTo, completedDateFrom, and completedDateTo filters. The following values are supported:

Z, UTC or GMT UTC
{+,-}N(N)(:MM) Zone offset in hours and minutes
UTC+<offset>, UTC-<offset>, GMT+<offset>, GMT-<offset>
IANA Time Zone Database region ID (example: the value for America/New_York is -04)

status

string enum, values: NEW, PENDING, PROCESSING, PENDING_REVIEW, PENDING_DOCUMENTS, AWAITING_INFORMATION, COMPLETED, EXPIRED, ERROR

Status of the IDV application. The following values are supported:

NEW The IDV application has been created in RocketKOR.
PENDING The IDV application has been submitted to the third-party IDV provider.
PROCESSING The IDV application is being processed by the third-party IDV provider.
PENDING_REVIEW The IDV application requires a manual review to continue the IDV process.
PENDING_DOCUMENTS The required documents for the IDV application have not been uploaded.
AWAITING_INFORMATION The IDV application requires additional information. For example, required fields may be missing from the Customer Account.
COMPLETED The IDV application is complete.
EXPIRED The IDV application has expired.
ERROR The IDV application could not be processed due to one or more errors.

Note that an IDV application cannot be COMPLETED until all entities linked to the application have a COMPLETED status.

identityVerificationProfileId

string

IDV profile used to process the IDV application.

accountId

string (UUID)

ID of the Business Account or Customer Account for which the IDV application was created.

outcome

string

Final outcome of the IDV application.

accountTypes

string enum, values: BUSINESS_ACCOUNT, BUSINESS_CUSTOMER, INDIVIDUAL_CUSTOMER

Type of account for which the IDV application was created. The following values are supported:

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

Use a comma-separated list to specify multiple values (example: INDIVIDUAL_CUSTOMER,BUSINESS_CUSTOMER).

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Identity Verification Application objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "content": [
    {
      "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"
        }
      ]
    },
    {...},
    {...}
  ]
}