Get Address Verification

Description

Returns a single address verification status and reason if the verification was rejected.

Request

HTTP Method: GET

URI Path: /v3/address_verifications/

URI Query Parameters:

Includes:

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

Examples

Approved VerificationRejected Verification

http

GET /v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e 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/c8e004b0-87ec-4987-b4fb-ee89db099f0e -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": "c8e004b0-87ec-4987-b4fb-ee89db099f0e",
        "type": "address_verifications",
        "attributes": {
            "service_description": null,
            "callback_url": null,
            "callback_method": null,
            "status": "Approved",
            "reject_reasons": null,
            "created_at": "2020-09-15T06:38:12.650Z",
            "reference": "SHB-485120"
        },
        "relationships": {
            "dids": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/dids",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/dids"
                }
            },
            "address": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/relationships/address",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/c8e004b0-87ec-4987-b4fb-ee89db099f0e/address"
                }
            }
        }
    },
    "meta": {
        "api_version": "2021-04-19"
    }
}

Other Responses

Code	Success	Description
401	No	Unauthorized