Identity Verification Application Object

The Identity Verification Application object represents details for an Identity Verification (IDV) application that has been submitted for a Business Account or Customer Account.

Attributes

string (UUID)

ID of the IDV application in the RocketKOR system.

businessAccountId

string (UUID)

ID of the Business Account that submitted the IDV application.

accountId

string (UUID)

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

identityVerificationProfileId

string

IDV profile used to process the IDV application.

firstName

string

First name of the Customer for which the IDV application was created. Applies to Individual Customers.

lastName

string

Last name of the Customer for which the IDV application was created. Applies to Individual Customers.

legalName

string

Legal name of the business for which the IDV application was created. Applies to Business Customers and Business Accounts.

accountType

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.

latestStatus

string enum, values: NEW, PENDING, PROCESSING, PENDING_REVIEW, AWAITING_INFORMATION, COMPLETED, 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 external provider.
PROCESSING The IDV application is being processed by the external provider.
PENDING_REVIEW The IDV application requires manual action.
AWAITING_INFORMATION The IDV application requires additional information.
COMPLETED The IDV application is complete.
ERROR The IDV application could not be processed due to one or more errors.

The application status is based on the statuses of the RocketKOR entities linked to the application. All entities must have a COMPLETED status in order for the application to have a COMPLETED status.

outcome

string

Final outcome of the IDV application.

statusHistory

object

Statuses that have been assigned to the IDV application during the processing lifecycle.

string (UUID)

Status ID.

status

string enum, values: NEW, PENDING, PROCESSING, PENDING_REVIEW, AWAITING_INFORMATION, COMPLETED, 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 external provider.
PROCESSING The IDV application is being processed by the external provider.
PENDING_REVIEW The IDV application requires manual action.
AWAITING_INFORMATION The IDV application requires additional information.
COMPLETED The IDV application is complete.
ERROR The IDV application could not be processed due to one or more errors.

The application status is based on the statuses of the RocketKOR entities linked to the application. All entities must have a COMPLETED status in order for the application to have a COMPLETED status.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the status was assigned to the IDV application in the RocketKOR system.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the status was last updated in the RocketKOR system.

identityVerificationId

string (UUID)

ID of the IDV application associated with the status.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the IDV application was created in the RocketKOR system.

createdBy

object

Entity that requested the IDV application creation.

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

updatedBy

object

Entity that last updated the IDV application.

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, service-account, internal

Type of entity. The following values are supported:

employee Team Member using the RocketKOR Portal.
service-account Service Account using APIs.
internal Internal service call.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the IDV application was last updated in the RocketKOR system.

entities

array

RocketKOR entities linked to the IDV application. Each entity will be verified as part of the IDV process.

The following entities are verified for each type of IDV application:

Application for a Business Account The Business Account and any Beneficiary Accounts are verified.
Application for a Business Customer The Customer Account and any Beneficiary Accounts are verified.
Application for an Individual Customer The Customer Account is verified.

accountId

string (UUID)

ID of the entity’s RocketKOR account. This could be a Business Account, a Customer Account, or a Beneficiary Account.

firstName

string

First name of the entity. Applies to Individual Customers and Beneficiaries.

lastName

string

Last name of the entity. Applies to Individual Customers and Beneficiaries.

legalName

string

Legal name of the entity. Applies to Business Customers and Business Accounts.

message

string

Current status of the entity.

entityType

string enum, values: BUSINESS_ACCOUNT, BUSINESS_CUSTOMER, BENEFICIARY, INDIVIDUAL_CUSTOMER

Type of entity. Possible values are:

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

status

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

Status of the entity’s 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 external provider.
PROCESSING The IDV application is being processed by the external provider.
PENDING_REVIEW The IDV application requires manual action.
AWAITING_INFORMATION The IDV application requires additional information.
COMPLETED The IDV application is complete.
ERROR The IDV application could not be processed due to one or more errors.

outcome

string

Final outcome of the entity’s IDV application.

outcomeDetails

object

Details for each outcome.

outcomeReasons

object

Outcome reasons.

name

string

Name of the outcome reason.

type

string

Type of outcome reason.

tags

string

Outcome detail tags.

processingSummary

map

Key/value pairs with the original fields and values from the submitted IDV application. Provides a snapshot of the application data.

Identity Verification Application Object

				
					{
  "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",
      "createdAt": "2023-08-09T21:16:37.250Z",
      "updatedAt": "2023-08-10T21:16:37.250Z",
      "identityVerificationId": "285d8b11-53f2-4bc0-957a-0e63897f1759"
    },
    {...},
    {...}
  ],
  "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": "",
      "message": "Invalid phone number",
      "entityType": "INDIVIDUAL_CUSTOMER",
      "status": "COMPLETED",
      "outcome": "APPROVED",
      "outcomeDetails": [
        {
          "outcomeReasons": [
            {
              "name": "Phone match",
              "type": "Fraud check"
            }
          ],
          "tags": [
            "Phone number matched"
          ]
        }
      ],
      "processingSummary": {
        "ADDRESS.CITY": "Chicago",
        "INFO.PRIMARY_PHONE_NUMBER": "123232333",
        "DOCS.PASSPORT": "ef2403f1-e350-4db9-b289-0c1e741be3d1"
      }
    }
  ]
}