Skip to main content
GET
/
v1
/
partner
/
clients
/
{clientEntityId}
Get a partner client
curl --request GET \
  --url https://api-sandbox.circle.com/v1/partner/clients/{clientEntityId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "clientEntityId": "880e8400-e29b-41d4-a716-446655440099",
    "clientName": "Acme Trust Co.",
    "country": "US",
    "clientType": "business",
    "businessDetails": {
      "natureOfBusiness": "paymentProcessorPlatform",
      "institutionType": "privateCo"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
clientEntityId
string<uuid>
required

Unique identifier of the client entity, as returned by the create partner client endpoint.

Example:

"880e8400-e29b-41d4-a716-446655440099"

Response

The requested client

​
data
object

A client created under your partner account. clientEntityId is always present; the remaining fields echo the details submitted when the client was created and are omitted when not available.