Overview

what my product is

FEATURES

Fast

easy to use

Specifications

Available
endpoints

GET subscribers/{phoneNumber}/kyc

Description

Retrieve subscriber KYC information by specifying the 'phoneNumber'.

Auth type

oauth2 Authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json

Query parameters

startDate string
An optional parameter, together with endDate, allows developers to specify a time range by which to query subscriber data on. If you want to request data for 2 months, then start date will need to set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months.Represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format
endDate string
An optional parameter, together with startDate, allows developers to specify a time range by which to query subscriber data on. If you want to request data for 2 months, then start date will need to set to 2 months prior to today, and endDate to todays date. If this is not set, the date range will be defaulted to 6 months. Represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format
200OK
statusCode integer

HTTP error code extension

statusMessage string

Detail message.

phoneNumber string

phoneNumber provided in the input

data
firstName string

First Name of entity associated with the input phoneNumber, this value is returned as uppercase.

lastName string

Last name of the entity associated with the input phoneNumber, this value is returned as uppercase.

idType string

Legal ID Type

nationalIdNumber string

Legal ID Number/Reference, this value will not contain any whitespace.

dateOfBirth string

Date of birth value of the entity associated with the input phoneNumber, represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format.

gender string

MALE,FEMALE

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "firstName": "string",
        "lastName": "string",
        "idType": "string",
        "nationalIdNumber": "string",
        "dateOfBirth": "string",
        "gender": "string"
    },
    "transactionId": "string"
}
400Bad Request
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
401Unauthorized
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
403Forbidden
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
404Not Found
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
405Method Not Allowed
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
406Not Acceptable
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
500Internal Server Error
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
GET subscribers/match-kyc/{phoneNumber}/kyc

Description

Verify if data provided matches subscriber data as identified by the 'phoneNumber' value provided.

Auth type

oauth2 Authorisation required
Please checkout the documentation to review how to access the endpoint via oAuth 2.

Header parameters

Content-Type application/json

Query parameters

firstName string
firstName
lastName string
lastName
nationalIdNumber string
nationalIdNumber
dateOfBirth string
End-User's birthday, represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format.
gender string
gender
200OK
statusCode integer

HTTP error code extension

statusMessage string

Message.

phoneNumber string

phoneNumber provided in the input

data
firstName string

firstName value that was passed to be matched with phoneNumber data.

firstNameMatch string

Y,N-NA,N-AV,N-AD

lastName string

lastName value that was passed to be matched with phoneNumber data.

lastNameMatch string

Y,N-NA,N-AV,N-AD

nationalIdNumber string

nationalIdNumber value that was passed to be matched with phoneNumber data.

nationalIdNumberMatch string

Y,N-NA,N-AV,N-AD

dateOfBirth string

dateOfBirth value that was passed to be matched with phoneNumber data.

dateOfBirthMatch string

Y,N-NA,N-AV,N-AD

gender string

gender value that was passed to be matched with phoneNumber data.

genderMatch string

Y,N-NA,N-AV,N-AD

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "phoneNumber": "string",
    "data": {
        "firstName": "string",
        "firstNameMatch": "string",
        "lastName": "string",
        "lastNameMatch": "string",
        "nationalIdNumber": "string",
        "nationalIdNumberMatch": "string",
        "dateOfBirth": "string",
        "dateOfBirthMatch": "string",
        "gender": "string",
        "genderMatch": "string"
    },
    "transactionId": "string"
}
400Bad Request
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
401Unauthorized
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
403Forbidden
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
404Not Found
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
405Method Not Allowed
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
406Not Acceptable
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}
500Internal Server Error
statusCode integer

HTTP error code extension

statusMessage string

More details and corrective actions related to the error which can be shown to a client.

SupportMessage string

Support Message

transactionId string

Transaction ID for tracing

{
    "statusCode": 1,
    "statusMessage": "string",
    "SupportMessage": "string",
    "transactionId": "string"
}

LARRY

PRICING