Address Requirement Validations#

Checks if the Address and/or Identity created is valid against the Address Requirement. The JSON:API resource type is address_requirement_validations.

Request#

HTTP Method: POST

URI Path: /v3/address_requirement_validations

Request Body Object Relationships#

Title

Type

Description

address_requirement

Address Requirement

Specifies the address requirement ID.

identity

Identity

Specifies the identity ID.

address

Address

Specifies the address ID.

Examples#

http

 1POST /v3/address_requirement_validations HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "type": "address_requirement_validations",
10    "relationships": {
11      "address_requirement": {
12        "data": {
13          "id": "ID_of_address_requirement",
14          "type": "address_requirements"
15        }
16      },
17      "address": {
18        "data": {
19          "id": "ID_of_Address",
20          "type": "addresses"
21        }
22      },
23      "identity": {
24        "data": {
25          "id": "ID_of_Identity",
26          "type": "identities"
27        }
28      }
29    }
30  }
31}

curl

1curl -i -X POST https://api.didww.com/v3/address_requirement_validations -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"relationships": {"address": {"data": {"id": "ID_of_Address", "type": "addresses"}}, "address_requirement": {"data": {"id": "ID_of_address_requirement", "type": "address_requirements"}}, "identity": {"data": {"id": "ID_of_Identity", "type": "identities"}}}, "type": "address_requirement_validations"}}'

response

 1HTTP/1.1 422 Unprocessable Entity
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "errors": [
 6        {
 7            "title": "Identity Place of Birth must be Germany",
 8            "detail": "Identity Place of Birth must be Germany",
 9            "code": "100",
10            "source": {
11                "pointer": "/data"
12            },
13            "status": "422"
14        },
15        {
16            "title": "2 Identity Proof(s) (Drivers License, National ID, Passport, Residence Permit, Visa, Other) required",
17            "detail": "2 Identity Proof(s) (Drivers License, National ID, Passport, Residence Permit, Visa, Other) required",
18            "code": "100",
19            "source": {
20                "pointer": "/data"
21            },
22            "status": "422"
23        },
24        {
25            "title": "Address in Germany required",
26            "detail": "Address in Germany required",
27            "code": "100",
28            "source": {
29                "pointer": "/data"
30            },
31            "status": "422"
32        }
33    ]
34}

Other Responses#

Code

Success

Description

400

No

Bad Request. The body carries a member the API does not accept.

401

No

Unauthorized

403

No

The access token carries the read scope, which does not cover this method (title Insufficient scope). The response carries WWW-Authenticate: Bearer error="insufficient_scope". See Scopes.

422

No

Validation Error Object. The requirement is not satisfied.

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.