Introduction

Swiftend allows you to verify the identities and addresses of other individuals all over the country. This could be for hiring, Background checks, etc.

Our APIs expose most of our services for you to be able to include our services into the great products you're building.

Response Structure

Every call to the actions of the service will return with 2 JSON objects.

  1. Response Info: Gives information about the response including (Response Code, message, parameters, and timestamp).

  2. Response Data: Contains actual details of the results based on the request.

Customers willing to consume this API must request for this service through the platform. In other words ONLY registered users are allowed to use this service. Once your request is received, an Admin will profile you on the system. Instantly an email containing your SERVICE ID will be sent to you.

Identity
API reference
Credit Bureau (CRS)
API reference
Need Help?

If you ever have any trouble while integrating. Contact our support

Base url
https://swiftend.com/
Response Structure
{
    "ResponseInfo":{
    "ResponseCode":"00",
    "Parameter":"23659814975",
    "Source":"BVN",
    "Message":"Results Found",
    "Timestamp":"21/10/2018 8:36:12PM"
    },

    "ResponseData":{
    "Firstname":"JOHN",
    "Lastname":"BULL",
    "DOB":"12-May-99",
    "Mobile":"08064567097",
    "ImageBase64":"---Truncated due to length (Base64 Encoded Photo)---"
    }
}

Authentication

All requests to Swiftend service is secured over SSL and also authenticates you using your credentials and a token. Every call to the service utilizes the standard HTTP operations (GET, POST). Requests and Responses are encrypted over the secure socket layer. In addition, every call is authenticated to mitigate against Man In The Middle attacks.

All calls must have one header variables for authentication

Headers | SERVICEID as sent to you earlier |

To retrieve your seriviceID, you have to do is:

  1. Create an account with us on our web platform
  2. Pass your username and password to swiftend.com/autheticate

After doing this, your API access credentials would be available to you. These credentials would be used to make API requests.

Base url
https://swiftend.com/authenticate
Request Body
{
    "email" : "[email protected]",
    "password" : "password"

 }

Status Code

Code Explaination Explaination
00 Success Successful search result
43 INSUFFICIENT WALLET BALANCE Wallet balance could not handle the request
87 Invalid Service ID Service ID could not be authenticated
88 NETWORK ERROR Larry
95 INVALID HASH TOKEN Token could not be authenticated
96 SERVICE UNAVAILABLE The requested service is unavailable
97 SYSTEM ERROR An error from the request or system. Requires admin to investigate.
99 RESULT NOT FOUND Unsuccessful search result
Response Sample
{
    "id": "910cbbb2-c9f6-47b9-83fe-74f1f1d985a2",
    "firstname": "John",
    "lastname": "Doe",
    "alias": "Mackintosh",
    "gender": "MALE",
    "dob": "25-08-2020",
    "phoneno": "08020000000",
    "fldstate": "Lagos",
    "fulladdress": "9, Jinodu Street, Agege",
    "lga": "Ifako Ijaiye",
    "notedetails": "we will let know if there is any note avialable",
    "photo1": "base64 string or NULL",
    "photo2": "base64 string or NULL",
    "photo3": "base64 string or NULL",
    "photo4": "base64 string or NULL",
    "fldstatus": "Pending",
    "successful": true,
    "Verifier": "VV International Bank",
    "cordinate": "9.99999,0.848484",
    "HouseType": "Residence",
    "callbackURL": "https://your-website.com",
    "identification_type": "PHOTO",
    "identification_id": "12345678900",
    "identification_image": "base64 string or NULL",
    "landmark": "close to estate bus stop behind zenith bank",
    "interviewee_full_name": "John Doe",
    "interviewee_telephone": "08030002124",
    "interviewee_address": "same as address or different",
    "created_at": "2020-06-23 09:19:12",
    "updated_at": "2020-06-24 09:19:12"
}
{
    "": "string"
}
{
    "": "string"
}
{
    "": "string"
}

Identity

When your customers create an account, Swiftend API helps you automate and streamline onboarding. Instantly get data and images from authority database, such as NIMC, BVN, Drivers License and verify against your customers declared information.

Nigeria

Bank Verification Number (BVN)

If you ever have any trouble while integrating.

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifybvn2/

Query Parameters

bvn required number

?bvn=22222222222

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifybvn2?bvn=22222222222
Response Sample
{
    "ResponseInfo": {
    "ResponseCode": "00",
    "Parameter": "22222222222",
    "Source": "BVN",
    "Message": "Results Found",
    "Timestamp": "08/12/2021 6:05:48 PM",
    "ResponseNIMC": "BVN API"
            },
    "ResponseData": {
    "BVN": "22222222222",
    "firstName": "John",
    "middleName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "15-Dec-1990",
    "phoneNumber1": "09011111112",
    "phoneNumber2": "",
    "registrationDate": "10-Jan-2015",
    "enrollmentBank": "100",
    "enrollmentBranch": "MATORI",
    "email": "[email protected]",
    "gender": "Male",
    "levelOfAccount": "Level 2 - Medium Level Accounts",
    "lgaOfOrigin": "Iseyin",
    "lgaOfResidence": "Ikeja",
    "maritalStatus": "Single",
    "nin": "00990090090",
    "nameOnCard": "John Doe Jane",
    "nationality": "Nigeria",
    "residentialAddress": "23, Loren Joe Street",
    "stateOfOrigin": "Bauchi State",
    "stateOfResidence": "Lagos State",
    "title": "Mr",
    "watchListed": "NO",
    "bvn": "0000099999}",
    "ImageBase64": "---Truncated due to length (Base64 Encoded Photo)---"
            }
}
{ 
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate
}

National Identity Number (NIN)

Queries a person NIN identity by specifying ID, Phone or Document number as kind. * Ensure to use supported kind and valid id of such kind to query data

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifynin?regNo=78541211447
Response Sample
{
    "ResponseInfo": {
    "ResponseCode": "00",
    "Parameter": "79132889978",
    "Source": "NIMC",
    "Message": "Results Found",
    "Timestamp": "12/06/2021 12:44:54 PM",
    "ResponseNIMC": null,
    },
    "ResponseData": {
    "nin": "70123456789",
    "firstname": "John",
    "middlename": "Doe",
    "surname": "Alamutu",
    "maidenname": "",
    "telephoneno": "08012345678",
    "state": "Ekiti",
    "place": "ADO ",
    "profession": "STUDENT",
    "title": "mr",
    "height": "****",
    "email": "",
    "birthdate": "01-01-1982",
    "birthstate": "Ekiti",
    "birthcountry": "nigeria",
    "centralID": "5227123",
    "documentno": "",
    "educationallevel": "tertiary",
    "employmentstatus": "",
    "nok_firstname": "John 2",
    "nok_lastname": "Doe 2",
    "nok_middlename": "",
    "nok_address1": "Address of NOK",
    "nok_address2": "",
    "nok_lga": "Garki",
    "nok_state": "Abuja",
    "nok_town": "Garki",
    "nok_postalcode": "",
    "othername": "Ayomide",
    "pfirstname": "Samad",
    "photo":"---Truncated due to length (Base64 Encoded Photo)---",
    "pmiddlename": "Emeka",
    "psurname": "Ahmed",
    "nspokenlang": "YORUBA",
    "ospokenlang": "ENGLISH",
    "religion": "christianity",
    "residence_Town": "IKOTUN EGBE",
    "residence_lga": "Alimosho",
    "residence_state": "Lagos",
    "residencestatus": "birth",
    "residence_AddressLine1": null,
    "residence_AddressLine2": "26 Billion STREET AGODO AREA",
    "self_origin_lga": "Alimosho",
    "self_origin_place": "",
    "self_origin_state": "Lagos",
    "signature": "---Truncated due to length (Base64 Encoded Photo)---",
    "nationality": "",
    "gender": "m",
    "trackingId": "S7Y0NYF812347WS"
   }
}
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Apache/2.4.51 (Debian)
X-Powered-By: PHP/7.4.26
Date: Fri, 09 Jan 2020 09:48:04 GMT
Cache-Control: no-store, no-cache, must-revalidate

International Passport (NIS)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifypassport/

Query Parameters

required

{ "passportId": "A02745229", "firstname" : "Abubakar", "lastname" : "Sadiq", "dob" : "1992-03-09" }

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

post /verifypassport
{
    "passportId": "A02745229",
    "firstname" : "Abubakar",
    "lastname" : "Sadiq",
    "dob" :  "1992-03-09"
}
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "A02551529",
        "Source": "Passport",
        "Message": "Results Found",
        "Timestamp": "12/08/2020 10:25:56 PM",
        "ResponseNIMC": "Passport"
    },
    "ResponseData": {
        "ID": "A02552529",
        "FirstName": "ABUBAKAR",
        "OtherName": "",
        "LastName": "SADIQ",
        "DateOfBirth": "1992-03-09",
        "phoneNumber": 08082177854,
        "Image": "---Truncated due to length (Base64 Encoded Photo)---",
	"Gender": "Male",
        "IssuedAt": "ABEOKUTA",
        "ExpiryDate": "2016-01-27",
        "IssuedDate": "2011-01-28"
    }
}
 {
     "error": "error",
 }

Drivers License (FRSC)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifylicense/

Query Parameters

license required number

?license=22222222222

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifyLicense/?id=LSR77518AA09
Response Sample
{
    "ResponseCode": "00",
    "Parameter": "LSR77518AA09",
    "Source": "DRIVERS LICENSE",
    "Message": "Results Found",
    "Timestamp": "12/09/2021 8:33:31 AM",
    "ResponseData": {
        "uuid": "1599561543",
        "licenseNo": "LSR70638AA09",
        "firstName": "SADIQ",
        "lastName": "UZOR",
        "middleName": "GOBLE",
        "gender": "Male",
        "issuedDate": "2019-09-13",
        "expiryDate": "2022-08-21",
        "stateOfIssue": "LAGOS",
        "birthDate": "1991-08-21",
        "photo": "---Truncated due to length (Base64 Encoded Photo)---"}
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Phone Number (Telco)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

/verifyphone2?phone=08023839179&searchtype=basic

Query Parameters

bvn required number

?phone=07034891150&searchtype=advance

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifyphone2?phone=07012345678
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "08123456789",
        "Source": "4",
        "Message": "Results Found",
        "Timestamp": "12/08/2021 11:00:53 AM"
    },
    "ResponseData": {
        "DATE_OF_BIRTH": "9-11-1977",
        "FIRST_NAME": "OLABODE",
        "GENDER": "Female",
        "LAST_NAME": "MAYOWA",
        "MSISDN": "08123456789",
        "AGE": "32",
        "OCCUPATION": "BUSINESS",
        "RESID_ADDR": "12 KOFO ABAYOMI, VICTORIA LAGOS",
        "RESID_STATE": "LAGOS",
        "RESID_LGA": "KOSOFE",
        "STATE_ORG": "LAGOS"
    }
}
 {
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate
}

Voter's Identification (VIN)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifyPvc/?pvc=90F5AFEC12295412458

Query Parameters

pvc required number

?pvc=90F5AFEC12295412458

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifyPvc/?pvc=90F5AFEC12295412458

Query Parameters

pvc required number

?pvc=90F5AFEC12295412458

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifyPvc/?pvc=90F5AFEC12295400000
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "90F5B1FFD8296400000",
        "Source": "Voter",
        "Message": "Results Found",
        "Timestamp": "12/10/2021 7:58:20 PM"
    },
    "ResponseData": {
        "voter_id": "90F5B1FFD8296400000",
        "firstname": "TADE",
        "middlename": null,
        "lastname": "THANKGOD",
        "address": "RAILWAY QUARTERS, ASABA.",
        "phone": "07036937019",
        "state": "ABIA",
        "lga": "ABA NORTH",
        "polling_unit_name": "RAILWAY QUARTERS, ASABA.",
        "gender": "MALE",
        "date_of_birth": "16-12-1978",
        "occupation": "FARMER"
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Account Name Enquiry (ANVS)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifyaccount/

Query Parameters

accountno required number

?accountno=01234567894

bankcode required number

?bankcode=054

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifyaccount?accountId=0174106067&bankCode=058
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "0609598958",
        "Source": "Account API",
        "Message": "Results Found",
        "Timestamp": "12/09/2021 11:16:22 AM",
        "ResponseNIMC": "Account API"
    },
    "ResponseData": {
        "Account": "JOHN AHMED JAMES",
        "FirstName": "JOHN",
        "MiddleName": "AHMED",
        "LastName": "AHMED",
        "AccountName": "JOHN AHMED JAMES",
        "AccountType": "2",
        "AccountCurrency": "NAIRA",
        "Address": "2 IBENO CLOSE, BICKEREST ES",
        "Address2": "",
        "City": "LAGOS",
        "Phone": "08123456789",
        "Gender": "Male",
        "PostalCode": "",
        "StateCode": "",
        "CountryCode": "",
        "BVNNumber": "22877441939",
        "Nationality": "Nigeria",
        "CountryOfBirth": "",
        "CountryOfIssue": "NIGERIA",
        "DOB": "24-Oct-2002",
        "Expiry": ""
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Card Verification (CBVS)

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifycard

Query Parameters

required

{ "secure_card" : "GswHEXkRwd8B6WdkYrhgZSEJIpZzHqXwroEZSMGBoL8=", "pan" : "5399237048543447", }

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

post /verifycard
{
    "secure_card" : "GswHEXkRwd8B6WdkYrhgZSEJIpZzHqXwroEZSMGBoL8=",
    "pan" : "5399237048543447",
}
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "0609598958",
        "Source": "Account API",
        "Message": "Results Found",
        "Timestamp": "12/09/2021 11:16:22 AM",
        "ResponseNIMC": "CBVS API"
    },
    "ResponseData": {
    	"Card_type": "Mastercard",
    	"Balance": "20,770.99",
    	"Bank": "Access",
    	"BankCode": "044"
        "Account": "JOHN AHMED JAMES",
        "FirstName": "JOHN",
        "MiddleName": "AHMED",
        "LastName": "AHMED",
        "AccountName": "JOHN AHMED JAMES",
        "AccountType": "2",
        "AccountCurrency": "NAIRA",
        "Address": "2 IBENO CLOSE, BICKEREST ES",
        "Address2": "",
        "City": "LAGOS",
        "Phone": "08123456789",
        "Gender": "Male",
        "PostalCode": "",
        "StateCode": "",
        "CountryCode": "",
        "BVNNumber": "22877441939",
        "Nationality": "Nigeria",
        "CountryOfBirth": "",
        "CountryOfIssue": "NIGERIA",
        "DOB": "24-Oct-2002",
        "Expiry": ""
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    X-Powered-By: PHP/7.4.26
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Ghana

International Passport

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/gh/verifypassport/

Query Parameters

passport_number required alphanumeric

?passport_number=01234567894

Response Schema

Query Parameters

PassportNo required string

The customer's Pasport Number

FirstName required string

The customer's first Name

LastName required string

The customer's last name

MiddleName required string

The customer's middle name

Nationality required string

The customer's Nationality

DateOfBirth required date

Date of birth of the person if available. in format dd/mm/yyyy

Gender required string

The customer's gender

PlaceOfBirth required string

The customer's place of birth

PlaceOfIssue required string

The place the customer's passport was issued

IssueDate required date

The date the customer passport was issued

ExpiryDate required date

Expiry Date of customer's passport

Picture required string

Base64 image string of photograph to identify the person

Signature required string

Base64 image string of signature to identify the person

get gh/verifypassport/?passport_number=G0000575
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "G0000575",
        "Source": "Passport",
        "Message": "Result Found",
        "Timestamp": "12/08/2020 10:25:56 PM",
        "ResponseNIMC": "Passport"
    },
    "ResponseData": {
        "PassportNo": "G0000575",
        "FirstName": "SAMUEL ",
        "LastName": "DENU",
        "MiddleName": "KWABLA",
        "Nationality": "GHANAIAN",
        "DateOfBirth": "23/05/1952",
        "Gender": "MALE",
        "PlaceOfBirth": "ADAKLU ABUADI",
        "PlaceOfIssue": "ACCRA",
        "IssueDate": "30/03/2010",
        "ExpiryDate": "30/03/2015",
        "Picture": "base64 Image",
        "Signature": "Base64 Image"
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Drivers License

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/gh/verifylicense/

Post Body

required
{
    "number": "12345678909",
    "dob" : "1992-03-09"
}
Response Schema

Query Parameters

Name required string

The customer's full Name

Nationality required string

The customer's Nationality

DateOfBirth required date

Date of birth of the person if available. in format dd/mm/yyyy

ProcessingCenter required string

Processiong center of license

ClassOfLicence required string

Class of license (A,B,C,D,E,F)

PlaceOfIssue required string

The place the customer's passport was issued

DateOfIssue required date

The date the customer passport was issued

ExpiryDate required date

Expiry Date of customer's passport

CertificateDate required date

License Certificate Date

CertificateOfCompetence required string

Certificate of competence code

DriverImage required string

Base64 image string of photograph to identify the person

PIN required string

License PIN

post gh/verifylicense/
{
    "number": "12345678909",
    "dob" : "1992-03-09"
}
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "G0000575",
        "Source": "License",
        "Message": "Result Found",
        "Timestamp": "12/08/2020 10:25:56 PM",
    },
    "ResponseData": {
        "Name": "OSEI YAW",
        "DateOfBirth": "07/10/1969",
        "ProcessingCenter": "AS5",
        "ClassOfLicence": "A",
        "Nationality": "GHANIAN",
        "DateOfIssue": "13/12/2016",
        "ExpiryDate": "13/12/2022",
        "CertificateDate": "05/02/2003",
        "CertificateOfCompetence": "070644",
        "DriverImage": "base64Image",
        "PIN": "OSEI-0069-00-01"
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Voters Card

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/gh/verifyvoter/

Post Body

required
{
    "number": "9001332866",
    "type" : "MAIN" OR "OLD"
}
                                                            
Response Schema

Body Parameters

Fullname required string

The customer's full Name

VoterID required number

The customer's voters Id

DateOfBirth required date

Date of birth of the person if available. in format dd/mm/yyyy

PollingStation required string

Polling station code

Age required string

Customer's age

Othernames required string

Customer's other name

RegDate required date

The date the customer voters card was registered

Surname required date

the custoemr's surname

Picture required string

Base64 image string of photograph to identify the person

post gh/verifyvoter/
{
    "number": "9001332866",
    "type" : "MAIN"
}
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "G0000575",
        "Source": "Voter",
        "Message": "Result Found",
        "Timestamp": "12/08/2020 10:25:56 PM",
    },
    "ResponseData": {
        "PollingStation": "E140901",
        "VoterID": "9001332866",
        "Age": "18",
        "DateOfBirth": "10/07/1998",
        "Sex": "F",
        "RegDate": "28/08/2016",
        "Fullname": "TETTEH KORKOR",
        "Picture": "base64Image",
        "PIN": "OSEI-0069-00-01",
        "Othernames": "KORKOR",
        "Surname": "TETTEH"
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Phone

If you ever have any trouble while integrating. Contact our support

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/gh/verifyphone/

Query Parameters

passport_number required alphanumeric

?=phone_number=2403832035

Response Schema

Body Parameters

phone_number required number

The customer's phone Number

first_name required string

The customer's first Name

last_name required string

The customer's last name

address1 required string

The customer's address line 1

address2 required string

The customer's address line 2

address3 required string

The customer's address line 3

address4 required string

The customer's address line 4

city required string

The customer's city

state_province required date

The customers's state province

country required string

The customer's country

zip_postal_code required string

The customer's postal code

email_address required string

The customer's email address

carrier required string

The network carrier

get gh/verifyphone/?phone_number=2403832035
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "G0000575",
        "Source": "Phone",
        "Message": "Result Found",
        "Timestamp": "12/08/2020 10:25:56 PM",
    },
    "ResponseData": {
        "phone_number": "2403832035",
        "first_name": "John",
        "last_name": "Doe",
        "address1": "116 Raymond Njoku Pkwy",
        "address2": "",
        "address3": "",
        "address4": "",
        "city": "Accra",
        "state_province": "Accra",
        "country": "GhanS",
        "zip_postal_code": "21210",
        "email_address": "",
        "carrier": "MTN"
    }
}
    Transfer-Encoding: chunked
    Content-Type: application/json; charset=utf-8
    Server: Apache/2.4.51 (Debian)
    Date: Fri, 09 Jan 2020 09:48:04 GMT
    Cache-Control: no-store, no-cache, must-revalidate

Business Verification

When your customers create an account, Swiftend API helps you automate and streamline onboarding. Instantly get data and images from authority database, such as NIMC, BVN, Drivers License and verify against your customers declared information.

Company Verification (CAC Search)

If you ever have any trouble while integrating.

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifycac3

Body required Object

{ "rc": "3116581", "type": "bn", "class" : "basic" }

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Request Schema

Query Parameters

rc required string

Company registration number

type required string

Business name, company name or incorporated trustee (BN, C) or IT)

class required string

Basic or Advance

Response Schema

Query Parameters

RC_Number string

Unique identification number assigned to business

Name_of_Company string

Company registered name

Type_of_Company string

Company based on mode of incorporation, liability of members and number of the members

Date_of_Registration string

Company registration date

Branch_Address string

Where the company is located

Email text

Registered company email

City string

City

Classification string

Business name, company name or incorporated trustee (BN, C) or IT)

Head_Office_Address string

Head office address

LGA string

Local government area of the office

Number_of_Affiliates string

Number of affiliates associated to the company

Share_capital string

Total value of funds raised by a company

Share_capital_in_words string

Total value of funds raised by a company in words

State string

State where the company is located

Status string

Status of the company (Active or Inactive)

imageReport string

Report of the search

post /verifycac3
{
    "rc": "3116581",
    "type": "bn",
    "class" : "basic"
}
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "200",
        "RCNo": "3116581",
        "type": "bn",
        "Message": "Result Found",
        "Timestamp": "12/10/2021 1:27:32 PM"
    },
    "ResponseData": {
        "RC_Number": "3116581",
        "Name_of_Company": "RHIKS CLOSET",
        "Type_of_Company": "BUSINESS_NAME",
        "Date_of_Registration": "2020-06-29T20:09:03.477+00:00",
        "Branch_Address": "9b Olatunde Oyefeso, Oniru Lagos",
        "Email": "[email protected]",
        "City": "Ikoyi",
        "Classification": "BUSINESS NAME",
        "Head_Office_Address": "9b Olatunde Oyefeso, Oniru Lagos",
        "LGA": "Eti Osa",
        "Number_of_Affiliates": "1",
        "Share_capital": "1,000,000",
        "Share_capital_in_words": "One Million Naira Only",
        "State": "LAGOS",
        "Status": "ACTIVE",
        "imageReport": "https://swiftidenity.s3.us-east-2.amazonaws.com/images/fb59929bd1f6830fbf468bff11de33d0swiftendipdf.pdf"
    }
}
{
    "ResponseInfo": {
        "ResponseCode": "200",
        "RCNo": "3116581",
        "type": "bn",
        "Message": "Result Found",
        "Timestamp": "12/10/2021 1:31:53 PM"
    },
    "ResponseData": {
        "RC_Number": "3116581",
        "Name_of_Company": "RHIKS CLOSET",
        "Type_of_Company": "BUSINESS_NAME",
        "Date_of_Registration": "2020-06-29T20:09:03.477+00:00",
        "Branch_Address": "",
        "Email": "",
        "City": "",
        "Classification": "BUSINESS NAME",
        "Head_Office_Address": "",
        "LGA": "Surulere",
        "Number_of_Affiliates": "1",
        "Share_capital": "",
        "Share_capital_in_words": "",
        "State": "LAGOS",
        "Status": "ACTIVE",
        "imageReport": "https://swiftidenity.s3.us-east-2.amazonaws.com/images/fb59929bd1f6830fbf468bff11de33d0swiftendipdf.pdf",
        "affiliates": [
            {
                "state": "OGUN",
                "name": "POPOOLA , ABOSEDE  MORENIKEJI",
                "id": 16313418,
                "address": "8, RAPHAEL MONYE CLOSE, PEACELAND ESTATE",
                "status": "ACTIVE",
                "uuid": null,
                "nationality": "Nigerian",
                "countryName": "NIGERIA",
                "firstname": "ABOSEDE ",
                "surname": "POPOOLA ",
                "affiliateType": "PROPRIETOR",
                "formerOtherName": null,
                "formerName": null,
                "dateOfBirth": null,
                "dateOfTermination": null,
                "streetNumber": null,
                "city": "AKUTE",
                "postcode": null,
                "corporateName": null,
                "companyId": 6387665,
                "isCorporate": false,
                "othername": "MORENIKEJI",
                "shareAllotted": null,
                "email": "[email protected]",
                "rcNumber": null,
                "shareType": null,
                "companyName": null,
                "lga": null,
                "gender": "FEMALE",
                "phoneNumber": "09034499199",
                "occupation": "BUSINESS WOMAN",
                "identityType": "International Passport",
                "dateOfAppointment": null,
                "identityNumber": "A07282981",
                "accreditationnumber": null,
                "corporationName": null,
                "formerFirstName": null,
                "formerNationality": null,
                "formerSurname": null,
                "isChairman": false,
                "otherDirectorshipDetails": null,
                "corporateRcNumber": null,
                "companyRcNumber": null,
                "searchScore": null
            }
        ]
    }
}

TIN Verifiation (FIRS)

Queries a person NIN identity by specifying ID, Phone or Document number as kind. * Ensure to use supported kind and valid id of such kind to query data

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Parameters

Header Parameters

SERVICEID required string

SERVICEID as sent to you earlier.

Path Parameters

url required string

https://swiftend.com/verifynin?regNo=78541211447

Kind of NIN query method using (NIN, Phone Number or Document Number)

regNo required nin number

78541211447

regNo required phone number

08082872144

regNo required doc number

1144021447

Response Schema

Query Parameters

firstname required string

The customer's first Name

lastname required string

The customer's last Name

alias required string

Alias or Nickname

gender required string

Gender of the person if available. MALE or FEMALE

dob required string

Date of birth of the person if available. in format dd-mm-yyyy

phoneno required number

Contact phone number

fldstate required string

State

fulladdress required string

Full address

lga required string

Local government Area

identification_type required string

Identification type, any of (BVN, NIN, PHOTO)

identification_id required string

Identification ID, required if the type is either BVN or NIN. Ignore if PHOTO

identification_image required string

Base64 image string (Size of image should be less than 100KB before it is base64 encoded) of photograph to identify the person

verifier required string

The name of the organization making the verification request

callbackURL required string

Callback URL to notify whenever the status of this address verification changes

Get /verifytin?query=177844101-0001
Response Sample
{
    "ResponseInfo": {
        "ResponseCode": "00",
        "Parameter": "177844101-0001",
        "Source": "WhoisID",
        "Message": "Results Found",
        "Timestamp": "12/10/2021 1:45:08 PM",
        "ResponseNIMC": "FIRS API"
    },
    "ResponseData": {
        "TIN": "17789701-0001",
        "Taxpayer_Name": "EDEN NIGERIA LIMITED",
        "CAC_Reg_No": "177844101-0001",
        "TypeofEntity": "RC1987831",
        "JITTIN": "10155720",
        "Tax_Office": "MSTO APAPA",
        "Phone_No": "[email protected]",
        "Email": "08104577749"
    }
}
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8
Server: Apache/2.4.51 (Debian)
X-Powered-By: PHP/7.4.26
Date: Fri, 09 Jan 2020 09:48:04 GMT
Cache-Control: no-store, no-cache, must-revalidate