RocketKOR

Design  /  Recipient Use Cases  /  Retrieve a Recipient

Retrieve a Recipient

Overview

In this use case, we’ll walk through retrieving detailed information for a 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).

API Operation

Steps

Send a request to the following endpoint:

GET /v1/recipients/{recipientId}

  • Include an Authorization header with your RocketKOR access token as a Bearer Token.
  • Use {recipientId} to specify the ID of the Recipient Account you want to retrieve.
  • Request body is not required.

Sample Response

The Recipient Account details are 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": "9055621258",
  "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"
}
				
			
ON THIS PAGE