Retrieve a Recipient

Retrieve a recipient. The recipient’s profile information is returned (name, email, mobile number, and address).

Endpoint

GET /v1/recipients/{recipientId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

recipientId REQUIRED

string (UUID)

ID of the recipient.

Request Body

None

Returns

Returns the Recipient object. This object contains the recipient details.

SAMPLE RESPONSE

				
					
  "status": "string",
  "result": {
    "id": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
    "businessAccountId": "8th32z87-3845-9810-v7gu-1f827g98swk3",
    "firstName": "John",
    "lastName": "Smith",
    "email": "jsmith@abc.com",
    "mobileNumber": "4161234567",
    "address": {
      "addressType": "Home",
      "streetLine1": "200 Queen St",
      "zipCode": "10001",
      "countryCode": "US",
      "stateCode": "NY",
      "cityName": "New York"
    },
    "createdAt": "2023-10-23T00:42:50.311Z",
    "updatedAt": "2023-10-30T00:42:50.311Z"
  },
  "message": "string"
}