Create Legal Address

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

POST {{Environment_URL}}/customers/v1/partner/legal/:cnpj/addresses

Headers

Name
Value

Authorization

Bearer <token>

Path Params

Key
Description
Required
Data Type
Example

cnpj

CNPJ in format 58393613000116

true

String

58393613000116

Body Params

Key
Description
Required
Data Type
Example

zipCode

Postal code. Must include - and have 9 digits (e.g., XXXXX-XXX)

true

String

12345-678

country

Country code in ISO 3166-1 alpha-3 format (3 uppercase letters)

true

String

BRA

state

State abbreviation. Must be 2 uppercase letters and a valid Brazilian state

true

String

SP

city

City name

true

String

São Paulo

neighborhood

Neighborhood name

true

String

Itaquera

street

Street name

true

String

Av Itaquera

number

Address number

true

Number

123

complement

Address complement (optional)

false

String

ap 10

nickname

Address alias

true

String

casa

default

Defines if this is the default address

true

Boolean

true

Observations

Attribute
Description

state

Must have 2 uppercase letters and be a valid Brazilian state

zipCode

Must include - and have 9 digits (e.g., XXXXX-XXX)

country

Must follow ISO 3166-1 alpha-3 format, with 3 uppercase letters

Request Body

Response