Skip to main content
POST
/
api
/
v1
/
operators
Create Operator
curl --request POST \
  --url https://payments.coinbase.com/api/v1/operators \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "entity": "<string>",
  "id": "<string>",
  "coinbaseUserId": "<string>",
  "name": "<string>",
  "status": "ACTIVATED",
  "smartAccountAddresses": {},
  "callbackSecret": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Authorization header using the Bearer scheme. Learn more about JWT tokens in the Coinbase Developer Portal.

Body

application/json

Request payload for creating an operator.

Request payload for creating an operator.

​
name
string
required

Name of the operator

Example:

"test.operator"

Response

A successful response.

Representation of an operator

​
entity
string
required

Entity type, usually 'operator'.

Example:

"operator"

​
id
string
required

Unique identifier of the operator.

Example:

"op-324235"

​
coinbaseUserId
string
required

Unique coinbase user identifier of the operator.

Example:

"cb-user-1234567890"

​
name
string
required

Name of the operator

Example:

"Test operator"

​
status
enum<string>
required

Current status of the operator.

Available options:
ACTIVATED,
DEACTIVATED,
PENDING
Example:

"ACTIVATED"

​
smartAccountAddresses
Smart Account Addresses · object
required

Map of smart account addresses associated with the operator, grouped by network ID.

Example:
{
  "8453": {
    "addresses": ["0xsmartaccount1", "0xsmartaccount2"]
  }
}
​
callbackSecret
string
required

The secret to encrypt callback payload

​
createdAt
string<date-time>
required

Timestamp when the operator was created.

Example:

"2024-03-20T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the operator was last updated.

Example:

"2024-03-20T00:00:00.000Z"