Forms

Validate field type

This method validates the field value against the field type

POST

/gb/form/validate/field-type

Validate field type

curl --request POST \
  --url https://api.catch-e.com/gb/form/validate/field-type \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_type": "integer",
  "field_value": "12345"
}
'

{
  "field_type": "integer",
  "field_value": "12345"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

JSON payload

field_typeenum<string>required

Type of field to validate. Note - Phone number and mobile numbers must follow E164 pattern.

Available options: currency, email, integer, e164phone, e164mobile, postcode, bank_bsb, bank_account_number

Example: integer

field_valuestringrequired

Value of the field

Example: 12345

Response

Success