Qodex.ai

Get Addresses

GET https://{{host}}/v3/addresses

Returns a list of Addresses on your account.

Request Params

KeyDatatypeRequiredDescription
includenullComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

country - Country Object

proofs - Proof Object

proofs.proof_type - Proof Type Object

identity - Identity Object

identity.country - Country Object

identity.proofs - Proof Object

identity.proofs.proof_type - Proof Type Object

identity.permanent_documents - Permanent Document Object

identity.permanent_documents.template - Supporting Document Template Object

area - Area Object

city - City Object | | filter[city_name] | null | | string - Filters by the city_name field.

  • Allow blank - Yes.
  • Allow array - No. | | filter[city_name_contains] | null | | string - Filters by the city_name_contains field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[postal_code] | null | | string - Filters by the postal_code field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[postal_code_contains] | null | | string - Filters by the postal_code_contains field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[address] | null | | string - Filters by the address field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[address_contains] | null | | string - Filters by the address_contains field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[description] | null | | string - Filters by the description field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[description_contains] | null | | string - Filters by the description_contains field.
  • Allow blank - Yes.
  • Allow array - No. | | filter[identity.id] | null | | string - Filters by the identity.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[country.id] | null | | string - Filters by the country.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[area.id] | null | | string - Filters by the area.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[city.id] | null | | string - Filters by the city.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | fields[addresses] | null | | The value of the fields parameter MUST be a comma-separated (U+002C COMMA, “,”) list that refers to the name(s) of the fields to be returned.
    An empty value indicates that no fields should be returned.

Allowed values:

city_name - The city_name field.

postal_code - The postal_code field.

address - The address field.

description - The description field.

created_at - The created_at field.

verified - The verified field. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

Allowed values:

city_name - Sorts by the city_name field.

postal_code - Sorts by the postal_code field.

address - Sorts by the address field.

description - Sorts by the description field. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":[{"id":"6f73fecd-6a7b-4440-93d7-41e0000baee0","type":"addresses","attributes":{"city_name":"Berlin","postal_code":"13089","address":"Leopoldstraße 38, Berlin Heinersdorf,Berlin","description":"none","created_at":"2021-06-08T08:38:25.433Z","verified":false},"relationships":{"identity":{"links":{"self":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity","related":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"}},"country":{"links":{"self":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country","related":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"},"data":{"type":"countries","id":"38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f"}},"proofs":{"links":{"self":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs","related":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"}},"area":{"links":{"self":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area","related":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"}},"city":{"links":{"self":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city","related":"https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"}}}}],"included":[{"id":"38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f","type":"countries","attributes":{"name":"Germany","prefix":"49","iso":"DE"},"relationships":{"regions":{"links":{"self":"https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/relationships/regions","related":"https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/regions"}}}}],"meta":{"total_records":1,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/addresses?include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/addresses?include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}