Qodex.ai

Get Address Verifications

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

Returns the address verifications status and reasons if the verification was rejected.

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:

address - Address Object

dids - DID Object

dids.did_group - DID Group Object | | filter[address.id] | null | | string - Filters by the address.id field.

  • Allow blank - Yes.
  • Allow array - Yes. | | filter[address.identity.id] | null | | string - Filters by the address.identity.id field.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[status] | null | | string - Filters by the status field.
  • Allow blank - No.
  • Allow array - No. | | filter[reference] | null | | string - Filters by the reference field.
  • Allow blank - No.
  • Allow array - Yes. | | fields[address_verifications] | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

Allowed values:

service_description - Sorts by the service_description field.

callback_url - Sorts by the callback_url field.

callback_method - Sorts by the callback_method field.

status - Sorts by the status field.

reject_reasons - Sorts by the reject_reasons field.

reference - Sorts by the reference field.

created_at - Sorts by the created_at field. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":[{"id":"9814cf4f-b472-4ea7-9275-565eb90be397","type":"address_verifications","attributes":{"service_description":null,"callback_url":"http://10.201.10.1/test.php","callback_method":"GET","status":"Rejected","reject_reasons":"The registration form should be fully filled and signed","reference":"XNH-144620","created_at":"2021-08-11T15:43:23.263Z"},"relationships":{"dids":{"links":{"self":"https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/dids","related":"https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/dids"},"data":[{"type":"dids","id":"9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc"}]},"address":{"links":{"self":"https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/relationships/address","related":"https://api.didww.com/v3/address_verifications/9814cf4f-b472-4ea7-9275-565eb90be397/address"}}}}],"included":[{"id":"9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc","type":"dids","attributes":{"blocked":true,"capacity_limit":55,"description":null,"terminated":false,"awaiting_registration":true,"created_at":"2018-11-28T09:40:31.684Z","billing_cycles_count":null,"number":"4921111111111","expires_at":"2021-08-19T17:32:21.390Z","channels_included_count":2,"dedicated_channels_count":0},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/did_group","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/did_group"}},"order":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/order","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/order"}},"voice_in_trunk":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk"}},"voice_in_trunk_group":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/voice_in_trunk_group","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/voice_in_trunk_group"}},"capacity_pool":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/capacity_pool","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/capacity_pool"}},"shared_capacity_group":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/shared_capacity_group","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/shared_capacity_group"}},"address_verification":{"links":{"self":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/relationships/address_verification","related":"https://api.didww.com/v3/dids/9e7e20b9-6142-4d5c-a001-cafa0ff9d7cc/address_verification"}}}}],"meta":{"total_records":1,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/address_verifications?include=dids\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/address_verifications?include=dids\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}