Recipient Object

id

string (UUID)

Unique ID assigned to the Recipient Account.

businessAccountId

string (UUID)

ID of the Business Account that the Recipient Account belongs to.

businessRefId

string, max length: 40, min length: 1

Your organization’s internal reference number assigned to the Recipient Account. This reference number is not used by RocketKOR.

firstName

string, max length: 40, min length: 1

Recipient’s first name.

middleName

string, max length: 40, min length: 1

Recipient’s middle name.

lastName

string, max length: 40, min length: 1

Recipient’s last name.

secondLastName

string, max length: 40, min length: 1

Recipient’s second last name.

email

string, max length: 320

Recipient’s email address.

phoneNumber

string, max length: 40

Recipient’s phone number. Example: 555-555-5555

nationality

string, max length: 3

Recipient’s nationality. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA.

dateOfBirth

string (date), required format: YYYY-MM-DD

Recipient’s date of birth.

additionalInformation

string, max length: 500, min length: 0

Additional information about the recipient.

recipientType

string enum, values: BUSINESS, INDIVIDUAL

default: INDIVIDUAL

Type of recipient.

businessName

string, max length: 40, min length: 1

Business name. Required if recipientType is BUSINESS.

state

string enum, values: ACTIVE, SUSPENDED

Current status of the Recipient Account. Possible values are ACTIVE (account is active) and SUSPENDED (account is inactive). A Recipient Account is ACTIVE when first created.

createdAt

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

Date and time the Recipient Account was created.

updatedAt

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

Date and time the Recipient Account was last updated.

requestorId

string (UUID)

ID of the entity that requested the Recipient Account creation. This could be a RocketKOR Business Account (if the account is created via an API) or a Team Member (if the account is created in the RocketKOR Portal).