Skip to main content
POST
/
api
/
v1
/
customers
Create a customer
curl --request POST \
  --url https://payments.oaknetwork.org/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_number": "12345678901",
  "document_type": "cpf",
  "email": "customer@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "dob": "1990-01-15",
  "phone_country_code": "+55",
  "phone_area_code": "11",
  "phone_number": "999999999",
  "country_code": "br"
}
'
{
  "msg": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "document_number": "<string>",
    "tax_id": "<string>",
    "document_type": "<string>",
    "email": "jsmith@example.com",
    "social_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "dob": "2023-11-07T05:31:56Z",
    "house_number": "<string>",
    "street_number": "<string>",
    "street_name": "<string>",
    "postal_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "phone_country_code": "<string>",
    "phone_area_code": "<string>",
    "phone_number": "<string>",
    "monthly_net_income": "<string>",
    "gender": "<string>",
    "country_code": "<string>",
    "roles": [
      "<string>"
    ],
    "wallet_address": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Body

application/json

Customer registration request. Fields document_type, country_code, and gender are case-insensitive (uppercased internally, returned lowercased).

​
document_number
string

Government document number

​
document_type
enum<string>

Document type (case-insensitive)

Available options:
cpf,
cnpj,
passport,
ssn,
itin,
cc,
curp,
personal_tax_id,
company_tax_id
​
email
string<email>
​
first_name
string
​
last_name
string
​
tax_id
string
​
dob
string<date>

Date of birth (ISO 8601)

​
phone_country_code
string
​
phone_area_code
string
​
phone_number
string
​
street_number
string
​
street_name
string
​
house_number
string
​
postal_code
string
​
city
string
​
state
string
​
country_code
string

ISO country code (case-insensitive)

​
subdivision
string

ISO subdivision code

​
gender
enum<string>

Gender (case-insensitive)

Available options:
male,
female,
other
​
mother_name
string
​
monthly_net_income
string
​
owner_legal_name
string
​
owner_document_number
string
​
owner_document_type
string
​
company_name
string
​
company_start_date
string
​
wallet_address
string

Response

Customer created

​
msg
string
required

Human-readable message describing the result

​
data
object
required

Response payload (null on error)