get/addresses/{id}

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/addresses/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Address identity identifier

Query parameters

string required
OR
string required

Response

OK

idstring required

Unique address identity identifier

agentIdstring required

Agent that owns this address

orgIdstring required

Organization the address belongs to

type'BILLING' | 'SHIPPING' | 'MAILING' | 'REGISTERED' required

Address type

labelstring nullable required

User-defined label

street1string required

Primary street address line

street2string nullable required

Secondary street address line

citystring required

City name

statestring required

State or province

postalCodestring required

Postal or ZIP code

countrystring required

2-character ISO country code

validatedboolean required

Whether the address has been validated

validatedAtstring date-time nullable required

Timestamp when the address was validated

providerstring nullable required

Validation provider name

metadataobject nullable required

Additional metadata

isPrimaryboolean required

Whether this is the primary address for its type

createdAtstring date-time required

Timestamp when the address was created

updatedAtstring date-time required

Timestamp when the address was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.