Skip to main content
POST
/
v1
/
externalEntities
Create an external entity
curl --request POST \
  --url https://api-sandbox.circle.com/v1/externalEntities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessName": "Circle Internet Financial Inc.",
  "businessUniqueIdentifier": "1234567890",
  "identifierIssuingCountryCode": "US",
  "address": {
    "country": "US",
    "state": "MA",
    "city": "Boston",
    "postcode": "01234",
    "streetName": "Main Street",
    "buildingNumber": "100"
  }
}
'
{
  "walletId": "212000",
  "businessName": "Circle Internet Financial Inc.",
  "businessUniqueIdentifier": "1234567890",
  "identifierIssuingCountryCode": "US",
  "complianceState": "PENDING"
}

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
​
businessName
string
required

The name of the business.

Example:

"Circle Internet Financial Inc."

​
businessUniqueIdentifier
string
required

The unique identifier of the business. For example, a company number or tax ID.

Example:

"1234567890"

​
identifierIssuingCountryCode
string
required

The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Pattern: ^[A-Z]{2}$
Example:

"US"

​
address
object
required

Response

Successfully created an external entity.

An external entity

​
walletId
string

Unique system-generated identifier for the wallet of the institutional entity.

Example:

"212000"

​
businessName
string

The name of the business.

Example:

"Circle Internet Financial Inc."

​
businessUniqueIdentifier
string

The unique identifier of the business. For example, a company number or tax ID.

Example:

"1234567890"

​
identifierIssuingCountryCode
string

The country code of the issuing authority. Formatted as a two-letter country code specified in ISO 3166-1 alpha-2.

Pattern: ^[A-Z]{2}$
Example:

"US"

​
complianceState
enum<string>

The compliance status of the external entity.

Available options:
PENDING,
ACCEPTED,
REJECTED