RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Create a Recipient

Add a new Recipient Account to a Business Account. The Recipient Account contains the recipient’s profile information (name, contact information, date of birth, and so on).

Endpoint

POST /recipients

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Request Body

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  REQUIRED

string, max length: 40, min length: 1

Recipient’s first name.

middleName

string, max length: 40, min length: 1

Recipient’s middle name.

lastName  REQUIRED

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  REQUIRED

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  CONDITIONAL

string, max length: 40, min length: 1

Business name. Required if recipientType is BUSINESS.

Returns

 

Returns the Recipient Account details, including a unique ID for the account. For details, see the Recipient object.

SAMPLE REQUEST

				
					{
  "businessRefId": "RECIP001",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "4161234567",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": ""
}
				
			

SAMPLE RESPONSE

				
					{
  "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "businessRefId": "RECIP001",
  "firstName": "John",
  "middleName": "",
  "lastName": "Smith",
  "secondLastName": "",
  "email": "jsmith@xyz.com",
  "phoneNumber": "4161234567",
  "nationality": "Canadian",
  "dateOfBirth": "1970-07-08",
  "additionalInformation": "",
  "recipientType": "INDIVIDUAL",
  "businessName": "",
  "state": "ACTIVE",
  "createdAt": "2021-07-08T20:56:35.219Z",
  "updatedAt": "2021-07-08T20:56:35.219Z",
  "requestorId": "9kj43t32-2956-2886-x7dy-6r821w39kra3"
}