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

Validation Request ErrorValidation Request Success

http

POST /v3/address_requirement_validations 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_requirement_validations",
    "relationships": {
      "address_requirement": {
        "data": {
          "id": "ID_of_address_requirement",
          "type": "address_requirements"
        }
      },
      "address": {
        "data": {
          "id": "ID_of_Address",
          "type": "addresses"
        }
      },
      "identity": {
        "data": {
          "id": "ID_of_Identity",
          "type": "identities"
        }
      }
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/address_requirement_validations -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --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

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/vnd.api+json

{
    "errors": [
        {
            "title": "Identity Place of Birth must be Germany",
            "detail": "Identity Place of Birth must be Germany",
            "code": "100",
            "source": {
                "pointer": "/data"
            },
            "status": "422"
        },
        {
            "title": "2 Identity Proof(s) (Drivers License, National ID, Passport, Residence Permit, Visa, Other) required",
            "detail": "2 Identity Proof(s) (Drivers License, National ID, Passport, Residence Permit, Visa, Other) required",
            "code": "100",
            "source": {
                "pointer": "/data"
            },
            "status": "422"
        },
        {
            "title": "Address in Germany required",
            "detail": "Address in Germany required",
            "code": "100",
            "source": {
                "pointer": "/data"
            },
            "status": "422"
        }
    ]
}

Other Responses

Code	Success	Description
401	No	Unauthorized