Create Address Verification#

Description

Creates an Address Verification Callback method to receive events related to Verification Status.

Request#

HTTP Method: POST

URI Path: /v3/address_verifications

URI Query Parameters:

Request Body Object Attributes:

Name

Type

Is Required?

Description

service_description

string

Optional

The description of verification task.

callback_url

string

Optional

The HTTP or HTTPS endpoint to where events related to verification task will be delivered.

callback_method

string

Optional

The HTTP Method used for verification task events. POST, GET are supported methods.

See Callback details for information about callback_url and callback_method.

Request Body Object Relationships:

Title

Type

Description

dids

DID

Specifies the ID of DID for verification task.

addresses

Addresses

Specifies the ID of Address for verification task.

onetime_files

Encrypted Files Object

Specifies Onetime files for verification task.

Testing#

Confirm the correct functioning of your integration by simulating approvals and rejections in the sandbox environment. This can be achieved by assigning specific testing values to the id_number attribute of the Identity, which will be utilized when creating the Address Verification. Refer to the table below for the available options.

Action

id_number value

approve

11111111-1111-1111-1111-111111111111

reject

22222222-2222-2222-2222-222222222222

Examples#

http

 1POST /v3/address_verifications HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Api-Key: [API token]
 6
 7{
 8  "data": {
 9    "type": "address_verifications",
10    "attributes": {
11      "callback_url": "http://example.com",
12      "callback_method": "GET"
13    },
14    "relationships": {
15      "onetime_files": {
16        "data": [
17          {
18            "id": "96fb69e0-d5bb-4637-b740-28349f1a4274",
19            "type": "encrypted_files"
20          }
21        ]
22      },
23      "dids": {
24        "data": [
25          {
26            "id": "723ba6a6-ec10-45f5-b2ba-84be6a4e0eb2",
27            "type": "dids"
28          }
29        ]
30      },
31      "address": {
32        "data": {
33          "id": "f13240d5-d3cc-4c05-a529-fb63a0027118",
34          "type": "addresses"
35        }
36      }
37    }
38  }
39}

curl

1curl -i -X POST 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" --data-raw '{"data": {"attributes": {"callback_method": "GET", "callback_url": "http://example.com"}, "relationships": {"address": {"data": {"id": "f13240d5-d3cc-4c05-a529-fb63a0027118", "type": "addresses"}}, "dids": {"data": [{"id": "723ba6a6-ec10-45f5-b2ba-84be6a4e0eb2", "type": "dids"}]}, "onetime_files": {"data": [{"id": "96fb69e0-d5bb-4637-b740-28349f1a4274", "type": "encrypted_files"}]}}, "type": "address_verifications"}}'

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "89c0164e-752f-4995-a0fa-0ced21e60e4a",
 7    "type": "address_verifications",
 8    "attributes": {
 9      "service_description": null,
10      "callback_url": "http://example.com",
11      "callback_method": "GET",
12      "status": "Pending",
13      "reject_reasons": null,
14      "created_at": "2021-03-23T12:20:04.584Z",
15      "reference": "SHB-485120"
16    },
17    "relationships": {
18      "dids": {
19        "links": {
20          "self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/dids",
21          "related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/dids"
22        }
23      },
24      "address": {
25        "links": {
26          "self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/address",
27          "related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/address"
28        }
29      }
30    }
31  },
32  "meta": {
33    "api_version": "2021-04-19"
34  }
35}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized