API docs by Redocly

FxTech Solutions (1.1.0)

Download OpenAPI specification:Download

Jason Wilmnas: jason@securefx.co.za

Validate

Our API validates the given reference material for connectness and authenticity.

Validate Individual

Validate the given individual data for authenticity and correctness

header Parameters
X-Partner-ID
required
string <uuid>
Request Body schema: application/json

Validate provided data

id_number
required
string

An individuals ID number

id_type
required
string
Enum: "ZA_ID" "ZA_PASSPORT"

The ID number type

first_name
string

The individuals first name as per their government ID

middle_name
string

The individuals middle name or names as per their government ID

last_name
string

The individuals last name as per their government ID

dob
string

The individuals date of birth in the example format

gender
string
Enum: "M" "F"

The individuals gender in single character format

phone_number
string
country
string

Responses

Request samples

Content type
application/json
{
  • "id_number": "string",
  • "id_type": "ZA_ID",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "dob": "21-06-1982",
  • "gender": "M",
  • "phone_number": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "is_valid": true,
  • "gender": "string",
  • "dob": "string"
}