Get customer

GET

customers

{id}

curl --request GET \
  --url https://base_url/api/v1/customers/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "b6d009b0-d174-463f-b030-94643c28e209",
    "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "John Doe",
    "created_at": 1727284490,
    "exemption_certificates": [
      {
        "id": "<string>",
        "expiring_at": "2023-12-25",
        "issued_at": "2023-12-25",
        "country": "US",
        "jurisdiction": "<string>",
        "status": "INVALID",
        "verification_status": "PENDING_VERIFICATION",
        "type": "PURPOSE_WHOLESALE",
        "customer_id": "<string>",
        "file_id": "<string>",
        "created_at": 1727284490
      }
    ]
  },
  "message": "Successfully fetched customer."
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The unique identifier of the customer to fetch.

Response

200

application/json

Detailed information about a specific customer

data

object

data.id

string

The unique identifier for this customer.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

data.corporation_id

string

The unique identifier for the corporation associated with this customer.

Example:

"2535af08-a139-4d0c-9827-1651e46dfbcf"

data.name

string

A display name for this customer.

Example:

"John Doe"

data.created_at

number

Timestamp in unix epoch

Example:

1727284490

data.exemption_certificates

object[]

data.exemption_certificates.id

string

required

Unique identifier for the exemption certificate

data.exemption_certificates.issued_at

string

required

ISO 8601 formatted string indicating the date when this exemption certificate was issued.

data.exemption_certificates.country

string

required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

data.exemption_certificates.jurisdiction

string

required

A string representing the jurisdiction: either a 2-letter state code (ISO 3166-2 suffix), 'SST', or 'MTC', depending on the exemption certificate details.

data.exemption_certificates.status

enum<string>

required

Determines whether the certificate is valid for use or not. If the certificate is INVALID, the POST /calculate endpoint won't use it for exemptions.

Available options:

VALID,

INVALID

Example:

"INVALID"

data.exemption_certificates.verification_status

enum<string>

required

Every exemption certificate needs to be validated by Commenda before they can be used for exempting transactions. This status indicates whether Commenda has verified the authenticity of this exemption certificate.

Available options:

PENDING_VERIFICATION,

VERIFICATION_COMPLETED

Example:

"PENDING_VERIFICATION"

data.exemption_certificates.type

enum<string>

required

Type of the exemption certificate. Request additional types from the Commenda team as required.

Available options:

PURPOSE_WHOLESALE,

ENTITY_TYPE_NONPROFIT

data.exemption_certificates.customer_id

string

required

The unique identifier of the customer associated with this exemption certificate.

data.exemption_certificates.file_id

string

required

Identifier of the file to use as the exemption certificate for this customer. Returned from the POST /files endpoint once the file is uploaded.

data.exemption_certificates.created_at

number

required

Timestamp in unix epoch

Example:

1727284490

data.exemption_certificates.expiring_at

string

ISO 8601 formatted date string indicating the date when this exemption certificate will expire. This is an optional field as some certificates might be valid indefinitely.

message

string

Example:

"Successfully fetched customer."

List customers Update customer

curl --request GET \
  --url https://base_url/api/v1/customers/{id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "b6d009b0-d174-463f-b030-94643c28e209",
    "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "John Doe",
    "created_at": 1727284490,
    "exemption_certificates": [
      {
        "id": "<string>",
        "expiring_at": "2023-12-25",
        "issued_at": "2023-12-25",
        "country": "US",
        "jurisdiction": "<string>",
        "status": "INVALID",
        "verification_status": "PENDING_VERIFICATION",
        "type": "PURPOSE_WHOLESALE",
        "customer_id": "<string>",
        "file_id": "<string>",
        "created_at": 1727284490
      }
    ]
  },
  "message": "Successfully fetched customer."
}

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

Authorizations

Path Parameters

Response