Criar um Cliente Individual ou Empresarial

curl --request POST \ --url https://api.spherepay.co/v2/customer \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "type": "individual", "email": "jane.smith@example.com", "phone": "+14155550123", "address": { "line1": "233 South Wacker Drive", "city": "Chicago", "state": "IL", "postalCode": "60606", "country": "USA" }, "personalInformation": { "firstName": "Jane", "lastName": "Smith", "dateOfBirth": "1990-04-15" } } '

{ "id": "customer_f31121c389624d3697cbf3ea8830b7a4", "type": "individual", "email": "jane.smith@example.com", "phone": "+14155550123", "firstName": "Jane", "lastName": "Smith", "verificationProfiles": [ { "name": "kyc_profile_a", "status": "incomplete", "criteria": { "complete": [ "email_address", "phone_number", "residential_address", "tax_identification_number" ], "pending": [], "required": [ "identity_document", "liveness_report_document" ], "errors": [] } } ], "meta": {}, "createdAt": "2026-03-09T20:46:31.305Z", "updatedAt": "2026-03-09T20:46:31.305Z" }

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

Individual Customer Create
Business Customer Create

type

enum<string>

obrigatório

Opções disponíveis:

individual

string<email>

obrigatório

The customer email address

Maximum string length: 254

Exemplo:

"jane.smith@example.com"

phone

string

obrigatório

The customer phone number in E.164 format

Pattern: ^\+(?:[0-9]){6,14}[0-9]$

Exemplo:

"+14155550123"

address

object

obrigatório

The customer's address.

Show child attributes

personalInformation

object

Personal information including tax identification details for individual customers. When any tax identification field is provided, all tax identification fields (number, type, country) and address are required. Please refer to the Individual Verification Criteria for the full list of reference.

Show child attributes

Resposta

Individual
Business

Response containing information about an individual customer.

string

obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

verificationProfiles

object[]

obrigatório

Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See KYC Flow for individuals or KYB Flow for businesses. See Verification Profile for individual status definitions and criteria breakdown or Verification Profile for business status definitions and criteria breakdown.

Show child attributes

Exemplo:

[
  {
    "name": "kyc_profile_a",
    "status": "incomplete",
    "criteria": {
      "complete": [
        "email_address",
        "phone_number",
        "residential_address",
        "tax_identification_number"
      ],
      "pending": [],
      "required": [
        "identity_document",
        "liveness_report_document"
      ],
      "errors": []
    }
  }
]

createdAt

string

obrigatório

ISO 8601 formatted customer creation timestamp

Exemplo:

"2026-03-09T20:46:31.305Z"

updatedAt

string

obrigatório

ISO 8601 formatted customer update timestamp

Exemplo:

"2026-03-09T20:46:31.305Z"

type

enum<string>

obrigatório

Customer type

Opções disponíveis:

individual

Exemplo:

"individual"

string

Customer email address

Exemplo:

"jane.smith@example.com"

phone

string

Customer phone number

Exemplo:

"+14155550123"