CommonCounterpart addresses

Create a counterpart address

Authentication

AuthorizationBearer

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

Path parameters

counterpart_idstringRequired

Headers

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

Request

This endpoint expects an object.
citystringRequired<=255 characters
City name.
countryenumRequired
Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
line1stringRequired<=255 characters
Street address.
postal_codestringRequired<=255 characters
ZIP or postal code.
line2stringOptional<=255 characters

Additional address information (if any).

statestringOptional<=255 characters
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](https://pe.usps.com/text/pub28/28apb.htm), for example, NY or CA.

Response

Successful Response
idstringformat: "uuid"
Unique ID of the address in the system
citystring<=255 characters
City name.
counterpart_idstringformat: "uuid"
ID of the counterpart that owns the address.
countryenum
Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
line1string<=255 characters
Street address.
postal_codestring<=255 characters
ZIP or postal code.
line2string or null<=255 characters

Additional address information (if any).

statestring or null<=255 characters
State, region, province, or county.

Errors