Requirement Validations

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

Checks if the Address and or Identity created is valid against the Requirement.

Request Body Scheme

{

data (object, required) {

type (string, required): requirement_validations

relationships (object, required) {

requirement (object, required): to-one
Specifies the Requirement.

address (object, optional): to-one
Specifies the Address.

identity (object, optional): to-one
Specifies the Identity.

}

}

}

Request Body Examples

{
  "data": {
    "type": "requirement_validations",
    "relationships": {
      "requirement": {
        "data": {
          "id": "ID_of_Requirement",
          "type": "requirements"
        }
      },
      "address": {
        "data": {
          "id": "ID_of_Address",
          "type": "addresses"
        }
      },
      "identity": {
        "data": {
          "id": "ID_of_Identity",
          "type": "identities"
        }
      }
    }
  }
}

---

{
  "data": {
    "type": "requirement_validations",
    "relationships": {
      "requirement": {
        "data": {
          "id": "ID_of_Requirement",
          "type": "requirements"
        }
      }
      "identity": {
        "data": {
          "id": "ID_of_Identity",
          "type": "identities"
        }
      }
    }
  }
}

---

{
  "data": {
    "type": "requirement_validations",
    "relationships": {
      "requirement": {
        "data": {
          "id": "ID_of_Requirement",
          "type": "requirements"
        }
      },
      "address": {
        "data": {
          "id": "ID_of_Address",
          "type": "addresses"
        }
      }
    }
  }
}

HEADERS

RESPONSES

status: Created

{"data":{"id":"3553253a-99eb-4303-a16a-6b1042d3f147","type":"requirement_validations"},"meta":{"api_version":"2021-12-15"}}