Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Get validation category

Used to get a validation category

  • GETMethod
  • /v2/validation/categories/categoryNameURL
URL fields
Name Type Description Restrictions
categoryName String The validation category name
Request parameters
Name Type Required / Optional Description Restrictions
fields String Optional Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.

Successful request

Validation category has been retrieved successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
name String Required The validation category name
fields List <String> Required The contact fields which have to be validated
terms List < terms > Optional
terms
Name Type Required / Optional Description
version Integer Required The version of the terms and conditions
terms String Required The content of the terms and conditions
validUntil Timestamp Optional Expiry date of the terms and conditions

Failed requests

Generic errors can be expected.

URL fields
The validation category name
Request parameters
Select fields to include in the response, comma separated list of field names. Requesting only the needed fields improves response time, especially when omitting relation fields. Identifying field(s) are always included.
Request

GET /v2/validation/categories/categoryName

Response