The Internal Financial Account object represents an internal Financial Account that has been created for a Customer Account.
id
string (UUID)
ID assigned to the Financial Account.
parentId
string (UUID)
ID of the Parent Financial Account. The internal Financial Account will use the same currency as this account.
businessAccountId
string (UUID)
ID of the Business Account that contains the Financial Account.
name
string, min length: 1, max length: 100
Name for the Financial Account. This is an informal name used for the account in RocketKOR.
category
string enum, value: INTERNAL
Financial Account category. Value must be INTERNAL.
type
string enum, value: BANK
Type of Financial Account. Value must be BANK.
subtype
string enum, value: CHECKING
Type of bank account. Value must be CHECKING.
defaultFlag
boolean, default: false
Whether this is the default Financial Account for transactions.
currency
string, min length: 3, max length: 3, default value: USD
Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code.
The internal Financial Account will use the same currency as the parent Financial Account.
accountHolderId
string (UUID)
ID of the entity that owns the Financial Account. The account holder must be a Customer Account.
accountHolderType
string enum, value: CUSTOMER
Type of entity referenced by the accountHolderId field. Value must be CUSTOMER.
state
string enum, values: PENDING, ACTIVE, SUSPENDED
Current status of the Financial Account. The following values are supported:
maskedAccountNumber
string
Masked account number for the bank account.
verificationStatus
object
Current verification status of the Financial Account.
verificationMethod
string enum, values: PRENOTE, AGGREGATION
Method used to verify the Financial Account.
createdBy
object
Entity that created the Financial Account.
id
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:
createdAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Financial Account was created.
updatedBy
object
Entity that last updated the Financial Account.
id
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:
updatedAt
string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz
Date and time the Financial Account was last updated.
Internal Financial Account Object
{
"id": "string(UUID)",
"parentId": "string(UUID)",
"businessAccountId": "string(UUID)",
"name": "string",
"category": "INTERNAL", // value must be INTERNAL
"type": "BANK", // value must be BANK
"subtype": "CHECKING", // value must be CHECKING
"defaultFlag": boolean,
"currency": "string",
"accountHolderId": "string(UUID)", // omitted if the account holder is a Business Account
"accountHolderType": "CUSTOMER", // omitted if the account holder is a Business Account
"state": "ACTIVE | PENDING | SUSPENDED",
"maskedAccountNumber": "string",
"verificationStatus": "UNVERIFIED | PENDING | PROCESSING | REVIEW | DECLINED | APPROVED | ERROR",
"verificationMethod": "PRENOTE | AGGREGATION",
"createdBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
},
"createdAt": "string(date-time)",
"updatedBy": {
"id": "string(UUID)",
"type": "employee | internal | kor_employee | service-account"
},
"updatedAt": "string(date-time)"
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
