Design / Recipient Use Cases / Create a Recipient

Create a Recipient

Overview

In this use case, we’ll walk through creating a new Recipient Account.

A Recipient is a business or individual that you intend to conduct business with on the RocketKOR platform. A Recipient Account contains the recipient’s profile (name, contact information, and so on).

Note One or more Financial Accounts can be linked to the Recipient Account. A Financial Account is a bank account or card account belonging to the recipient.

API Operation

Create a Recipient

Steps

Send a request to the following endpoint:

POST /v1/recipients

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Include details about the business or individual in the request body (name, contact information, date of birth, and so on). For a list of required fields, see the API Reference.

Sample Request

The following request would create a new Recipient Account for an individual.

				
					{
  "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

If the Recipient Account creation is successful, a unique ID is returned for the account. Details about the account creation and the recipient’s profile are also returned. For details, see the Recipient object.

				
					{
  "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"
}

Create a Recipient

Overview

API Operation

Steps

Sample Request

Sample Response

ON THIS PAGE