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 |
|
Optional |
The description of verification task. |
callback_url |
|
Optional |
The HTTP or HTTPS endpoint to where events related to verification task will be delivered. |
callback_method |
|
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 |
Specifies the ID of DID for verification task. |
|
addresses |
Specifies the ID of Address for verification task. |
|
onetime_files |
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
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": {
"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"
}
}
}
}
}
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": "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"}}'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "89c0164e-752f-4995-a0fa-0ced21e60e4a",
"type": "address_verifications",
"attributes": {
"service_description": null,
"callback_url": "http://example.com",
"callback_method": "GET",
"status": "Pending",
"reject_reasons": null,
"created_at": "2021-03-23T12:20:04.584Z",
"reference": "SHB-485120"
},
"relationships": {
"dids": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/dids",
"related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/dids"
}
},
"address": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/address",
"related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/address"
}
}
}
},
"meta": {
"api_version": "2021-04-19"
}
}
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",
"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"
}
}
}
}
}
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", "service_description": "string"}, "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"}}'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "89c0164e-752f-4995-a0fa-0ced21e60e4a",
"type": "address_verifications",
"attributes": {
"service_description": "string",
"callback_url": "http://example.com",
"callback_method": "GET",
"status": "Pending",
"reject_reasons": null,
"created_at": "2021-03-23T12:20:04.584Z",
"reference": "SHB-485120"
},
"relationships": {
"dids": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/dids",
"related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/dids"
}
},
"address": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/relationships/address",
"related": "https://sandbox-api.didww.com/v3/address_verifications/89c0164e-752f-4995-a0fa-0ced21e60e4a/address"
}
}
}
},
"meta": {
"api_version": "2021-04-19"
}
}
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",
"service_description": "string"
},
"relationships": {
"onetime_files": {
"data": [
{
"id": "606911e3-ae91-4717-8d16-39d85de906fc",
"type": "encrypted_files"
}
]
},
"dids": {
"data": [
{
"id": "e750ea2f-b1a0-4cf7-887d-0cab23ee4138",
"type": "dids"
}
]
},
"address": {
"data": {
"id": "ef8bedc8-4e2a-4064-b2b2-e08270eabe1b",
"type": "addresses"
}
}
}
}
}
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", "service_description": "string"}, "relationships": {"address": {"data": {"id": "ef8bedc8-4e2a-4064-b2b2-e08270eabe1b", "type": "addresses"}}, "dids": {"data": [{"id": "e750ea2f-b1a0-4cf7-887d-0cab23ee4138", "type": "dids"}]}, "onetime_files": {"data": [{"id": "606911e3-ae91-4717-8d16-39d85de906fc", "type": "encrypted_files"}]}}, "type": "address_verifications"}}'
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/vnd.api+json
{"errors": [
{
"title": "one-time document is not needed",
"detail": "one-time document is not needed",
"code": "100",
"source": {"pointer": "/data"},
"status": "422"
},
{
"title": "service description is not needed",
"detail": "service description is not needed",
"code": "100",
"source": {"pointer": "/data"},
"status": "422"
}
]}
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": "dd769be0-d5ef-4c6f-b000-89cd2a780d7f",
"type": "dids"
}
]
},
"address": {
"data": {
"id": "4f97a28d-d8be-4c00-bf72-df175e4d44c3",
"type": "addresses"
}
}
}
}
}
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": "4f97a28d-d8be-4c00-bf72-df175e4d44c3", "type": "addresses"}}, "dids": {"data": [{"id": "dd769be0-d5ef-4c6f-b000-89cd2a780d7f", "type": "dids"}]}}, "type": "address_verifications"}}'
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/vnd.api+json
{"errors": [
{
"title": "1 Identity Proof(s) (National ID, Passport) required",
"detail": "1 Identity Proof(s) (National ID, Passport) required",
"code": "100",
"source": {"pointer": "/data"},
"status": "422"
},
{
"title": "Following Supporting Document(s) required (Germany Registration Form)",
"detail": "Following Supporting Document(s) required (Germany Registration Form)",
"code": "100",
"source": {"pointer": "/data"},
"status": "422"
},
{
"title": "1 Address Proof(s) (Copy of Phone Bill, Utility Bill, Rental Receipt, Other) required",
"detail": "1 Address Proof(s) (Copy of Phone Bill, Utility Bill, Rental Receipt, Other) required",
"code": "100",
"source": {"pointer": "/data"},
"status": "422"
}
]}
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 -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"}}'
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"data": {
"id": "4e4d684b-9263-47e1-8f85-8fa5851c4b39",
"type": "address_verifications",
"attributes": {
"service_description": null,
"callback_url": "http://example.com",
"callback_method": "GET",
"status": "Pending",
"reject_reasons": null,
"reference": "QGO-154482",
"created_at": "2023-02-27T09:09:26.747Z"
},
"relationships": {
"dids": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/4e4d684b-9263-47e1-8f85-8fa5851c4b39/relationships/dids",
"related": "https://sandbox-api.didww.com/v3/address_verifications/4e4d684b-9263-47e1-8f85-8fa5851c4b39/dids"
}
},
"address": {
"links": {
"self": "https://sandbox-api.didww.com/v3/address_verifications/4e4d684b-9263-47e1-8f85-8fa5851c4b39/relationships/address",
"related": "https://sandbox-api.didww.com/v3/address_verifications/4e4d684b-9263-47e1-8f85-8fa5851c4b39/address"
}
}
}
},
"meta": {
"api_version": "2021-04-19"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |