Get a user's address by type

GET 
/api/users/:userId/addresses/:type

Requires admin token. Returns the user's address of the given type. Supported types: policy.

Request

Path Parameters

userId stringrequired
type stringrequired
Address type
Example: policy

Responses

200

The address.

application/json

Schema

Schema

addressLine1 string

Street Address Line 1

addressLine2 string

Street Address Line 2

city string

City

state string

2 Letter State Code

country string

2 Letter Country Code

zip string

Zip

Example (from schema)

{
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "zip": "string"
}

400

Unknown address type. Possible error codes

1. ERROR_INVALID_PARAMETERS

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

401

Authorization error e.g. due to an invalid or missing API keys.

403

Forbidden. Possible error codes

1. ERROR_NO_PERMISSIONS_TO_RESOURCE

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

404

User or address not found. Possible error codes

1. ERROR_USER_NOT_FOUND

2. ERROR_ADDRESS_NOT_FOUND

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

500

Internal error. Possible error codes

1. INTERNAL_SERVER_ERROR

application/json

Schema

Schema

error_code string

Error code

error_message string

A verbose error message

Example (from schema)

{
  "error_code": "string",
  "error_message": "string"
}

Loading...