Validate counterparty Id

POST /api/v1/transfers/validate-counterparty-id

Validate counterparty Id

cURL

curl --request POST \
  --url https://api.international.coinbase.com/api/v1/transfers/validate-counterparty-id \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "counterparty_id": "CBTQDGENHE"
}
'

200

{
  "counterparty_id": "CBTQDGENHE",
  "valid": true
}

Java

TransfersService transfersService = IntxServiceFactory.createTransfersService(client);
ValidateCounterpartyIdRequest request = new ValidateCounterpartyIdRequest.Builder()
    .counterpartyId("counterparty_id")
    .build();
ValidateCounterpartyIdResponse response = transfersService.validateCounterpartyId(request);

For more information, please visit the INTX Java SDK.

.NET

var transfersService = new TransfersService(client);
var request = new ValidateCounterpartyIdRequest(
    CounterpartyId: "counterparty_id",
);
var response = transfersService.ValidateCounterpartyId(request);

For more information, please visit the INTX .NET SDK.

Go

transfersSvc := transfers.NewTransfersService(client)
request := &transfers.ValidateCounterpartyIdRequest{
    CounterpartyId: "counterparty_id",
}
response, err := transfersSvc.ValidateCounterpartyId(context.Background(), request)

For more information, please visit the INTX Go SDK.

Python

client = IntxClient()
request = ValidateCounterpartyIdRequest(
    counterparty_id="counterparty_id",
)
response = client.validate_counterparty_id(request)

For more information, please visit the INTX Python SDK.

TS/JS

const transfersService = new TransfersService(client);

transfersService.validateCounterparty({
    counterpartyId: 'COUNTERPARTY_ID_HERE',
}).then(async (response) => {
    console.log('Counterparty created: ', response);
})

For more information, please visit the INTX TS SDK.

CLI

intxctl validate-counterparty-id --help

For more information, please visit the INTX CLI.

Authorizations

CB-ACCESS-KEY · string · header · required

The Client ID that owns the API Key for the request

CB-ACCESS-PASSPHRASE · string · header · required

The pass phrase affiliated with the API Key

CB-ACCESS-SIGN · string · header · required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

CB-ACCESS-TIMESTAMP · string · header · required

The timestamp of when the request is being made

Body

application/json

counterparty_id · string · required

Counterparty Id to be validated

Example:

"CBTQDGENHE"

Response

200

application/json

Return whether the counterparty Id is valid to withdraw to

counterparty_id · string

Counterparty Id

Example:

"CBTQDGENHE"

valid · boolean

Whether the counterparty Id is valid to withdraw to

Example:

true