Create Physical Address

Create Physical Address

This endpoint is used to create a customer address. Some operations require the customer to have a registered address.

POST {{Environment_URL}}/customers/v1/partner/physical/:cpf/addresses

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Key	Description	Required	Data Type	Example
cpf	CPF in format 00000000000	true	String	12345678900

Body params

Key	Type	Required	Description
nickname	string	No	Nickname or label for the address.
street	string	Yes	Street name of the address.
number	number	Yes	Address number.
complement	string	No	Additional address details (e.g., apartment, block).
neighborhood	string	Yes	Neighborhood of the address.
city	string	Yes	City of the address.
state	string	Yes	State or province.
zipCode	string	Yes	Postal code (ZIP code).
country	string	No	Country of the address.
default	boolean	Yes	Indicates whether this is the default address.

Request Body

Create Physical Address

{
  "nickname": "Casa",
  "street": "Rua das Flores",
  "number": 123,
  "complement": "Apto 45",
  "neighborhood": "Centro",
  "city": "São Paulo",
  "state": "SP",
  "zipCode": "01001-000",
  "country": "Brasil",
  "default": true
}

Response

201 - Success

[
    {
    "id": "68bf1e2943f2478b516c3f2d",
    "country": "Brasil",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Centro",
    "street": "Rua das Flores",
    "number": 123,
    "complement": "Apto 45",
    "zipCode": "01001-000",
    "default": true,
    "nickname": "Casa",
    "fullAddress": "Rua das Flores, 123 Apto 45 - Centro - São Paulo/SP, Brasil - 01001-000"
  }
]