CommonCounterpart addresses

Create a counterpart address

Path parameters

counterpart_idstringRequired

Headers

AuthorizationstringRequired

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

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
citystringRequired
City name.
countryenumRequired

Two-letter ISO country code (ISO 3166-1 alpha-2).

line1stringRequired
Street address.
postal_codestringRequired
ZIP or postal code.
line2stringOptional

Additional address information (if any).

statestringOptional

State, county, province, prefecture, region, or similar component of the counterpart’s address. For US counterparts, state is required and must be a two-letter USPS state abbreviation, for example, NY or CA.

Response

Successful Response
idstringformat: "uuid"
Unique ID of the address in the system
citystring
City name.
counterpart_idstringformat: "uuid"
ID of the counterpart that owns the address.
countryenum

Two-letter ISO country code (ISO 3166-1 alpha-2).

line1string
Street address.
postal_codestring
ZIP or postal code.
line2string or null

Additional address information (if any).

statestring or null
State, region, province, or county.

Errors