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

POST /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]

{
  "data": {
    "type": "address_verifications",
    "attributes": {
      "callback_url": "http://example.com",
      "callback_method": "GET"
    },
    "relationships": {
      "dids": {
        "data": [
          {
            "id": "b0c54164-03b9-42fa-b052-68a95bdab67b",
            "type": "dids"
          },
          {
            "id": "95e9d153-4881-4a6a-85a0-9b9e68f817eb",
            "type": "dids"
          }
        ]
      },
      "address": {
        "data": {
          "id": "a1f03dae-ea44-4348-993f-ce1c68ca1c21",
          "type": "addresses"
        }
      }
    }
  }
}

curl

curl -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": "a1f03dae-ea44-4348-993f-ce1c68ca1c21", "type": "addresses"}}, "dids": {"data": [{"id": "b0c54164-03b9-42fa-b052-68a95bdab67b", "type": "dids"}, {"id": "95e9d153-4881-4a6a-85a0-9b9e68f817eb", "type": "dids"}]}}, "type": "address_verifications"}}'

response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "b2f40660-2cdb-4ed6-98e0-2a7c23c0bce6",
        "type": "address_verifications",
        "attributes": {
            "service_description": null,
            "callback_url": "http://example.com",
            "callback_method": "GET",
            "status": "Pending",
            "reject_reasons": null,
            "reference": "TTC-388920",
            "created_at": "2023-02-27T09:01:04.275Z"
        },
        "relationships": {
            "dids": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/b2f40660-2cdb-4ed6-98e0-2a7c23c0bce6/relationships/dids",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/b2f40660-2cdb-4ed6-98e0-2a7c23c0bce6/dids"
                }
            },
            "address": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_verifications/b2f40660-2cdb-4ed6-98e0-2a7c23c0bce6/relationships/address",
                    "related": "https://sandbox-api.didww.com/v3/address_verifications/b2f40660-2cdb-4ed6-98e0-2a7c23c0bce6/address"
                }
            }
        }
    },
    "meta": {
        "api_version": "2022-05-10"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized