Requirements
Cancel a pending requirement version
Cancel a pending requirement version. The pending version is marked as cancelled and the previously active version is restored with effective_end_at set to NULL.
delete/requirements/{id}/versions/pending
Path parameters
idstring uuid required
Uniquely identifies the requirement_type record
Response
Pending version cancelled successfully
Example response
{
"data": {
"cancelled": {
"action": "ordering",
"country_code": "FR",
"created_at": "2021-04-09T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"locality": "Nice",
"phone_number_type": "local",
"record_type": "requirement",
"requirement_types": [
{
"acceptance_criteria": {
"acceptable_characters": "abcdef0123456789",
"acceptable_values": [
"US"
],
"locality_limit": "Issued by the same country that the phone number belongs to",
"max_length": 20,
"min_length": 16,
"time_limit": "Current and not expired"
},
"created_at": "2021-04-09T22:25:27.521Z",
"description": "Proves the customer has a physical address in the same locality as the phone number",
"example": "Utility bill, internet bill, phone bill, or lease",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "Proof of Address",
"record_type": "requirement_type",
"type": "document",
"updated_at": "2021-04-12T20:20:20.020Z"
}
],
"updated_at": "2021-04-12T20:20:20.020Z"
},
"restored": {
"action": "ordering",
"country_code": "FR",
"created_at": "2021-04-09T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"locality": "Nice",
"phone_number_type": "local",
"record_type": "requirement",
"requirement_types": [
{
"acceptance_criteria": {
"acceptable_characters": "abcdef0123456789",
"acceptable_values": [
"US"
],
"locality_limit": "Issued by the same country that the phone number belongs to",
"max_length": 20,
"min_length": 16,
"time_limit": "Current and not expired"
},
"created_at": "2021-04-09T22:25:27.521Z",
"description": "Proves the customer has a physical address in the same locality as the phone number",
"example": "Utility bill, internet bill, phone bill, or lease",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "Proof of Address",
"record_type": "requirement_type",
"type": "document",
"updated_at": "2021-04-12T20:20:20.020Z"
}
],
"updated_at": "2021-04-12T20:20:20.020Z"
}
}
}