- Getting Started
- Endpoints
- Authentication
- Customers
- Exemptions
- Transactions
- Address Validation
- Sales Tax Rates
- Vat Validation
- Special Features
Get All Customers
GET
/v1/customers
customer
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox.complyt.io/v1/customers'
Responses
🟢200Successful operation
application/json
Body
The buyer. All transactions are associated with a customer
complytId
string <uuid>
optional
externalId
string
required
>= 1 characters<= 256 characters
source
string
required
Match pattern:
^(10|[1-9])$
name
string
optional
>= 1 characters<= 256 characters
address
object
optional
city
string
optional
>= 0 characters<= 100 characters
country
string
optional
>= 0 characters<= 50 characters
county
string
optional
>= 0 characters<= 100 characters
state
string
optional
>= 0 characters<= 100 characters
street
string
optional
>= 0 characters<= 200 characters
region
string
optional
>= 0 characters<= 20 characters
zip
string
optional
>= 0 characters<= 20 characters
email
string
optional
customerType
enum<string>
required
Allowed values:
RETAILMARKETPLACERESELLERRETAIL_EXEMPT
internalTimestamps
object (internalTimestamps)
optional
createdDate
string
required
updatedDate
string
required
externalTimestamps
object (externalTimestamps)
required
createdDate
string
required
updatedDate
string
required
comment
string
optional
>= 0 characters<= 200 characters
Example
{
"complytId": "9f8ee193-1a71-42b4-801d-ee1d8a161fbe",
"externalId": "externalIdExample",
"source": "sourceExample",
"name": "Complyt",
"address": {
"city": "Sacramento",
"country": "US",
"county": null,
"state": "CA",
"street": "944 W. Wintergreen St.",
"zip": "95823",
"isPartial": false
},
"email": "example@some.mail.com",
"customerType": "RETAIL",
"internalTimestamps": {
"createdDate": "2023-01-10T17:40:44.357",
"updatedDate": "2023-01-11T17:10:21.275"
},
"externalTimestamps": {
"createdDate": "2022-10-19T07:00:00",
"updatedDate": "2022-10-19T09:07:54.585"
},
"comment": "this is a customer"
}
🟠400Something is wrong with your request
🟠401Unauthorized
🟠403Forbidden
🔴500Internal Error
Modified at 2025-01-01 15:21:30