curl --request POST \
--url https://api.example.com/partner/clover/customers \
--header 'Content-Type: application/json' \
--header 'X-API-NONCE: <x-api-nonce>' \
--header 'X-API-SIGNATURE: <x-api-signature>' \
--header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
--header 'X-API-TIMESTAMP: <x-api-timestamp>' \
--data '
{
"business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"organization_type": "<string>",
"business_description": "<string>",
"ein": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"business_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": true,
"is_public": true,
"government_affiliated": true,
"affiliated_entities": true,
"operations_abroad": true,
"types_of_customers": "<string>",
"international_customers_served": true
},
"persons": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"home_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"tin": "<string>",
"email": "<string>",
"phone": 123,
"phone_mobile": 123,
"gender": "<string>",
"employer_name": "<string>",
"employment_status": "<string>",
"occupation": "<string>",
"ownership_percentage": 123,
"work_title": "<string>",
"controller": true,
"created_at": "2023-11-07T05:31:56Z"
}
],
"external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>",
"type": "<string>"
}
}
'{
"message": "Unauthorized",
"error_type": "unauthorized",
"request_part": "headers"
}Onboard a customer.
curl --request POST \
--url https://api.example.com/partner/clover/customers \
--header 'Content-Type: application/json' \
--header 'X-API-NONCE: <x-api-nonce>' \
--header 'X-API-SIGNATURE: <x-api-signature>' \
--header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
--header 'X-API-TIMESTAMP: <x-api-timestamp>' \
--data '
{
"business": {
"business_name": "<string>",
"dba": "<string>",
"naics_code": 123,
"organization_type": "<string>",
"business_description": "<string>",
"ein": "<string>",
"formation_state": "<string>",
"formation_date": "<string>",
"business_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"mailing_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"phone": 123,
"email": "<string>",
"website": "<string>",
"backup_withholding": true,
"is_public": true,
"government_affiliated": true,
"affiliated_entities": true,
"operations_abroad": true,
"types_of_customers": "<string>",
"international_customers_served": true
},
"persons": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "2023-12-25",
"home_address": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"tin": "<string>",
"email": "<string>",
"phone": 123,
"phone_mobile": 123,
"gender": "<string>",
"employer_name": "<string>",
"employment_status": "<string>",
"occupation": "<string>",
"ownership_percentage": 123,
"work_title": "<string>",
"controller": true,
"created_at": "2023-11-07T05:31:56Z"
}
],
"external_bank_account": {
"bank_name": "<string>",
"name_on_account": "<string>",
"address_on_account": {
"street_1": "<string>",
"street_2": "<string>",
"city": "<string>",
"state": "<string>",
"zip_code": "<string>",
"country": "<string>"
},
"routing_number": "<string>",
"account_number": "<string>",
"type": "<string>"
}
}
'{
"message": "Unauthorized",
"error_type": "unauthorized",
"request_part": "headers"
}Signature header
Timestamp header
Nonce header
Account ID header
Schema to deserialize the customer request.
Successful Response