Identity Verification Application Object

The Identity Verification (IDV) Application object represents details for an 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, 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.

outcome

string

Final outcome of the IDV application. Only returned for applications with a COMPLETED status.

statusHistory

array

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

message

string

Status message provided by RocketKOR or the IDV provider.

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.

outcome

string

Latest outcome of the IDV application. Only returned for applications with a COMPLETED status.

metadata

string, max properties: 6, value max length: 1024

Key/value pairs used to store additional information about the IDV application.

completedAt

string (date-time)

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

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 created the IDV application.

string (UUID)

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

type

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

Type of entity. The following values are supported:

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

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, internal, kor_employee, service-account

Type of entity. The following values are supported:

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

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 Beneficial Owners are verified.
Application for a Business Customer The Customer Account and any Beneficial Owners 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, Customer Account, or Beneficial Owner.

firstName

string

First name of the entity. Applies to Individual Customers and Beneficial Owners.

lastName

string

Last name of the entity. Applies to Individual Customers and Beneficial Owners.

legalName

string

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

entityType

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

Type of entity. Possible values are:

BENEFICIARY Beneficial Owner.
BUSINESS_ACCOUNT Business Account.
BUSINESS_CUSTOMER Business Customer Account.
INDIVIDUAL_CUSTOMER Individual Customer Account.

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.

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

array of strings

Outcome detail tags.

statusHistory

array

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

string (UUID)

Status ID.

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.

message

string

Status message provided by RocketKOR or the IDV provider.

createdAt

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

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

updatedAt

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

Date and time the entity’s IDV application status was last updated in the RocketKOR system.

entityId

string (UUID)

ID of the entity associated with the status.

processingSummary

string

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

docUploadUrl

string

URL to upload required documents for the entity’s IDV application. This URL is returned for applications with a PENDING_DOCUMENTS status.

createdAt

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

Date and time the entity was created in the RocketKOR system.

createdBy

object

Entity that created the entity linked to the IDV application.

string (UUID)

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

type

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

Type of entity. The following values are supported:

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

updatedBy

object

Entity that last updated the entity.

string (UUID)

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

type

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

Type of entity. The following values are supported:

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

updatedAt

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

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

Identity Verification Application Object

				
					{
  "id": "string(UUID)",
  "businessAccountId": "string(UUID)",
  "accountId": "string(UUID)",
  "identityVerificationProfileId": "string",
  "firstName": "string",
  "lastName": "string",
  "legalName": "string",
  "accountType": "BUSINESS_ACCOUNT | BUSINESS_CUSTOMER | INDIVIDUAL_CUSTOMER",
  "latestStatus": "NEW | PENDING | PROCESSING | PENDING_REVIEW | PENDING_DOCUMENTS | AWAITING_INFORMATION | COMPLETED | EXPIRED | ERROR",
  "outcome": "string",
  "statusHistory": [
    {
      "id": "string(UUID)",
      "status": "NEW | PENDING | PROCESSING | PENDING_REVIEW | PENDING_DOCUMENTS | AWAITING_INFORMATION | COMPLETED | EXPIRED | ERROR",
      "message": "string",
      "createdAt": "string(date-time)",
      "updatedAt": "string(date-time)",
      "outcome": "string"
    },
    {...},
    {...}
  ],
  "metadata": {
    "key": "value"
  },
  "completedAt": "string(date-time)",
  "createdAt": "string(date-time)",
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | service-account"
  },
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | service-account"
  },
  "updatedAt": "string(date-time)",
  "entities": [
    {
      "accountId": "string(UUID)",
      "firstName": "string",
      "lastName": "string",
      "legalName": "string",
      "entityType": "BENEFICIARY | BUSINESS_ACCOUNT | BUSINESS_CUSTOMER | INDIVIDUAL_CUSTOMER",
      "status": "NEW | PENDING | PROCESSING | PENDING_REVIEW | PENDING_DOCUMENTS | AWAITING_INFORMATION | COMPLETED | EXPIRED | ERROR",
      "outcome": "string",
      "outcomeDetails": [
        {
          "outcomeReasons": [
            {
              "name": "string",
              "type": "string"
            }
          ],
          "tags": [
            "string"
          ]
        }
      ],
      "statusHistory": [
        {
          "id": "string(UUID)",
          "status": "NEW | PENDING | PROCESSING | PENDING_REVIEW | PENDING_DOCUMENTS | AWAITING_INFORMATION | COMPLETED | EXPIRED | ERROR",
          "message": "string",
          "createdAt": "string(date-time)",
          "updatedAt": "string(date-time)",
          "entityId": "string(UUID)"
        },
        {...},
        {...}
      ],
      "processingSummary": {
        "key": "value",
        "key": "value",
        "key": "value"
      },
      "docUploadUrl": "string",
      "createdAt": "string(date-time)",
      "createdBy": {
        "id": "string(UUID)",
        "type": "employee | internal | service-account"
      },
      "updatedBy": {
        "id": "string(UUID)",
        "type": "employee | internal | service-account"
      },
      "updatedAt": "string(date-time)"
    }
  ]
}