Register Physical Person

Register Physical Person

POST {{Environment_URL}}/customers/v1/partner/physical

Body Params

Key	Description	Required	Data Type	Example
name	Full name	true	String	MARIA EDUARDA FERREIRA LIMA
cpf	CPF in format 000.000.000-00	true	String	123.456.789-00
nickname	Preferred name or alias	true	String	dudinha
email	Email address	true	String	[email protected]
profession	Current profession or occupation	false	String	Analista de Dados
rg	Brazilian identity document	true	String	987654321
revenue	annual revenue in BRL	true	Number	7520.30
mobile	Mobile phone number	true	String	[phone]
birthDate	Date of birth (YYYY-MM-DD)	true	String (Date)	1985-03-12
addresses	List of addresses related to the person	true	Array of objects	See addresses table below
naturality	City of birth	false	String	Rio de Janeiro

addresses object:

Key	Description	Required	Data Type	Example
nickname	Address nickname	false	String	Apartamento Copacabana
street	Street name	true	String	Av. Atlântica
number	Street number	true	Number	2230
complement	Additional address info (e.g., apt, suite).	false	String	Ap 1201
neighborhood	Neighborhood name	true	String	Copacabana
city	City name	true	String	Rio de Janeiro
state	State abbreviation (e.g., RJ, SP)	true	String	RJ
zipCode	Postal code	true	String	22021-001
country	Country name	false	String	Brasil
default	Marks this address as the default	true	Boolean	true

Headers

Name	Value
Authorization	Bearer <token>

Request Body

Register Physical Person

{
    "name": "Sharon Wilderman",
    "cpf": "123.456.789-00",
    "nickname": "Elmore",
    "email": "[email protected]",
    "profession": "Analista de Dados",
    "rg": "987654321",
    "revenue": 7520.30,
    "mobile": "[phone]",
    "birthDate": "1985-03-12",
    "addresses": [
        {
            "nickname": "Apartamento Copacabana",
            "street": "Av. Atlântica",
            "number": 170,
            "complement": "Ap 1201",
            "neighborhood": "Copacabana",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "zipCode": "22021-001",
            "country": "Brasil",
            "default": true
        }
    ],
    "naturality": "Rio de Janeiro"
}

Response

201 - Success

{
    "cpf": "123.456.789-00",
    "rg": "987654321",
    "birthDate": "1985-03-12T00:00:00.000Z",
    "naturality": "Rio de Janeiro",
    "profession": "Analista de Dados",
    "revenue": 7520.3,
    "changeSync": false,
    "id": "6897912ce6e84da5ad182561",
    "name": "Dr. Roberto Breitenberg",
    "nickname": "Genoveva",
    "email": "[email protected]",
    "mobile": "[phone]",
    "status": "pending",
    "documents": [
        {
            "id": "6897912ce6e84da5ad182562",
            "documentType": "CPF",
            "versions": [
                {
                    "id": "6897912ce6e84da5ad182563",
                    "files": [],
                    "approved": true,
                    "createdAt": "2025-08-09T18:19:24.794Z"
                }
            ],
            "hateoas": {
                "self": {
                    "update": {
                        "href": "/customers/physicals/123.456.789-00/documents/6897912ce6e84da5ad182562",
                        "rel": "PUT"
                    }
                },
                "create": {
                    "href": "/customers/physicals/123.456.789-00/documents/6897912ce6e84da5ad182562",
                    "rel": "POST"
                }
            }
        }
    ],
    "addresses": [
        {
            "id": "6897912ce6e84da5ad182564",
            "country": "Brasil",
            "state": "RJ",
            "city": "Rio de Janeiro",
            "neighborhood": "Copacabana",
            "street": "Av. Atlântica",
            "number": 170,
            "complement": "Ap 1201",
            "zipCode": "22021-001",
            "default": true,
            "nickname": "Apartamento Copacabana",
            "fullAddress": "Av. Atlântica, 170 Ap 1201 - Copacabana - Rio de Janeiro/RJ, Brasil - 22021-001"
        }
    ],
    "billingAddresses": [],
    "accounts": [],
    "beneficiaries": [],
    "wlCorrespondents": [
        111
    ],
    "verified": {
        "email": false,
        "mobile": false,
        "address": false
    },
    "createdAt": "2025-08-09T18:19:24.797Z",
    "updatedAt": "2025-08-09T18:19:24.797Z",
    "pendencies": [
        "email_confirmation"
    ],
    "limitHistory": [],
    "operationCount": 0
}

400 - Bad Request