Retrieve a requirement types
GET/requirement_types/:id
Retrieve a requirement type by id
Request
Path Parameters
Uniquely identifies the requirement_type record
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
object
acceptance_criteria
object
Specifies objective criteria for acceptance
Specifies time-based acceptance criteria
Specifies geography-based acceptance criteria
Specifies the list of strictly possible values for the requirement. Ignored when empty
Specifies objective criteria for acceptance
Describes the requirement type
Provides one or more examples of acceptable documents
Possible values: [document
, address
, textual
]
Defines the type of this requirement type
A short descriptive name for this requirement_type
Identifies the type of the resource
Identifies the associated document
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was last updated.
{
"data": {
"acceptance_criteria": {
"time_limit": "Current and not expired",
"locality_limit": "Issued by the same country that the phone number belongs to",
"acceptable_values": [
"US"
]
},
"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",
"type": "document",
"name": "Proof of Address",
"record_type": "requirement_type",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"created_at": "2021-04-09T22:25:27.521Z",
"updated_at": "2021-04-12T20:20:20.020Z"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}