Developer Docs

NTSA

# Request Parameters

The following parameters are expected:

Field Description Type
search_type The Search type you want to do. Examples: ntsa String
identifier This is the search parameter. E.g. "KAA123A" String

Please find sample implementation on the left

# Response Parameters

Below is a sample response

'search_type' is ntsa and identifier is the client's Registration Number

Search details on a customer's NTSA using their Registration Number. As sample response is as follows:

{
  "code": "200.001",
  "data": {
    // Response data object containing NTSA details
    "account_no": "string", // Account number associated with NTSA record
    "title": "string", // Title of the NTSA record
    "date_created": "string", // ISO 8601 timestamp of record creation
    "id": "string", // Unique identifier (UUID) for the record
    "client_name": "string | null", // Name of the client
    "phone": "string | null", // Contact phone number
    "id_no": "string | null", // National ID number
    "passport_no": "string | null", // Passport number
    "status": "string", // Current status of the record (e.g. "Completed")
    "trend_status": "string | null", // Trend status indicator
    "score_type_name": "string", // Type of score (e.g. "NTSA")
    "id_verified": "boolean | null", // ID verification status
    "passport_verified": "boolean | null", // Passport verification status
    "gender": "string | null", // Gender of the individual
    "citizenship": "string | null", // Citizenship status
    "ethnic_group": "string | null", // Ethnic group classification
    "serial_number": "string | null", // Serial number associated with record
    "place_of_birth": "string | null", // Place of birth
    "place_of_live": "string | null" // Current place of residence
  }
}

← DMVIC →