Get Address Verifications

Description

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

Request

HTTP Method: GET

URI Path: /v3/address_verifications

URI Query Parameters:

Name	Type	Is Required?	Description
filter[<filter_name>]	string	Optional	Filtering
include	string	Optional	Inclusion

Includes:

Value	Description
address	Addresses Object
dids	DID Object
dids.did_group	DID Group Object

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
address.id	string	Yes	Yes	The address.id field.
address.identity.id	string	Yes	Yes	The address.identity.id field.
status	string	No	No	The status field.
reference	string	No	Yes	The reference field.

Fielding:

Value	Returns:
service_description	The service_description attribute.
callback_url	The callback_url attribute.
callback_method	The callback_method attribute.
status	The status attribute.
reject_reasons	The reject_reasons attribute.
reference	The reference attribute.
created_at	The created_at attribute.

Examples

Simple RequestFilter by statusInclude dids

http

GET /v3/address_verifications HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/address_verifications -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
   "data": [
      {
            "id": "40c315d2-255c-410f-9af7-6b288c3f8ba4",
            "type": "address_verifications",
            "attributes": {
               "service_description": "testing",
               "callback_url": null,
               "callback_method": null,
               "status": "Rejected",
               "reject_reasons": "The DID cannot be used for the indicated service",
               "reference": "EGE-764403",
               "created_at": "2021-03-22T06:24:58.295Z"
            },
            "relationships": {
               "dids": {
                  "links": {
                        "self": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/dids",
                        "related": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/dids"
                  }
               },
               "address": {
                  "links": {
                        "self": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/relationships/address",
                        "related": "https://sandbox-api.didww.com/v3/address_verifications/40c315d2-255c-410f-9af7-6b288c3f8ba4/address"
                  }
               }
            }
      }
   ],
   "meta": {
      "total_records": 1,
      "api_version": "2022-05-10"
   },
   "links": {
      "first": "https://sandbox-api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50",
      "last": "https://sandbox-api.didww.com/v3/address_verifications?page%5Bnumber%5D=1&page%5Bsize%5D=50"
   }
}

Other Responses

Code	Success	Description
401	No	Unauthorized