Create Address Verification

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

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

Request Body Scheme

{

data (object, required) {

type (string, required): address_verifications

attributes (object, required) {

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.

service_description (string, optional)
The description of verification task.

}

relationships (object, required) {

onetime_files (object, optional): to-many
Specifies the Encrypted File Objects for Onetime file of verification task.

dids (object, required): to-many
Specifies the IDs of DIDs for verification task.

address (object, required): to-one
Specifies the ID of Address for verification task.

}

}

}

See Callback details for information about callback_url and callback_method.

Request Body Example

{
  "data": {
    "type": "address_verifications",
    "attributes": {
      "callback_url": "http://10.201.10.1/test.php",
      "callback_method": "GET",
      "service_description": "string"
    },
    "relationships": {
      "onetime_files": {
        "data": [
          {
            "id": "96fb69e0-d5bb-4637-b740-28349f1a4274",
            "type": "encrypted_files"
          }
        ]
      },
      "dids": {
        "data": [
          {
            "id": "723ba6a6-ec10-45f5-b2ba-84be6a4e0eb2",
            "type": "dids"
          }
        ]
      },
      "address": {
        "data": {
          "id": "f13240d5-d3cc-4c05-a529-fb63a0027118",
          "type": "addresses"
        }
      }
    }
  }
}

HEADERS

RESPONSES

status: Created

{"data":{"id":"89c0164e-752f-4995-a0fa-0ced21e60e4a","type":"address_verifications","attributes":{"service_description":"string","callback_url":"http://10.201.10.1/test.php","callback_method":"GET","status":"Pending","reject_reasons":null,"created_at":"2021-03-23T12:20:04.584Z","reference":"SHB-485120"},"relationships":{"dids":{"links":{"self":"https://api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/dids","related":"https://api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/dids"}},"address":{"links":{"self":"https://api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/address","related":"https://api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/address"}}}},"meta":{"api_version":"2021-12-15"}}