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

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
clientName
string
required

Name for the client entity.

Example:

"Acme Trust Co."

​
country
string
required

ISO 3166-1 alpha-2 country code for the client's primary jurisdiction.

Required string length: 2
Example:

"US"

​
clientType
enum<string>
required

Type of client. Currently business is the only supported value.

Available options:
business
Example:

"business"

​
businessDetails
object
required

Business-specific details. Required only when clientType is business. Omit this object for non-business client types.

Response

Client created and application initialized

​
data
object