v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Recipients (Send to Others)

Get Recipient by Idempotency Key

Retrieve a recipient using its idempotency key.

Functionality:

Looks up a recipient by the idempotency key provided during creation
Useful for safely retrying create requests

get/v1/customers/{customer_id}/recipients

Path parameters

customer_idstring required

Unique identifier of the customer

Query parameters

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

The idempotency key used during resource creation. Used to safely retrieve or check the status of a resource after creation, especially useful for handling network failures or timeout scenarios.

Response

Successfully retrieved recipient by idempotency key

recipient_idstring required

Counterparty ID. Empty values are still allowed for legacy DB columns where an empty cpid means the record is not tied to a recipient.

customer_idstring required

Portfolio ID — also exposed as customer_id in OpenAPI. Identifies one individual application / portfolio row within an entity.

business_typestring required

Recipient type: INDIVIDUAL or COMPANY

full_namestring required

Full name computed from name fields

nicknamestring nullable

User-defined nickname (optional)

emailstring nullable

Email address (optional)

relationshipstring nullable

Relationship to the customer (optional)

statusstring required

Recipient status. Possible values: active, in_review, failed

created_atstring date-time required

Created timestamp

modified_atstring date-time required

Last modified timestamp

Example response

{
  "recipient_id": "4728c2b9-6df7-11f0-b1f6-6a7838eca3f8",
  "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
  "business_type": "INDIVIDUAL",
  "full_name": "John Doe",
  "nickname": "John's Business",
  "email": "john.doe@example.com",
  "relationship": "VENDOR",
  "status": "active",
  "address": {
    "full_address": "490 2nd St Suite 300, San Francisco, CA 94107",
    "country_code": "USA",
    "address_line1": "490 2nd St",
    "address_line2": "Suite 300",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94107"
  },
  "created_at": "2025-10-29T02:46:25.096305Z",
  "modified_at": "2025-10-29T02:46:25.096305Z"
}