Versions Compared

Old Version 12

changes.mady.by.user Amanuel Nega

Saved on

compared with

New Version Current

changes.mady.by.user Amanuel Nega

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Welcome to the Paga KYC API Developer page. You'll find all the information you need to use the KYC API. Including Sample requests and responses.

1. Introduction

This API is used to query the KYC status of Paga consumers.

KYC Stands for “Know Your Customer”. Know your customer (KYC) policy is an important step developed globally to prevent identity theft, financial fraud, money laundering and terrorist financing. The objective of KYC is to enable banks to know and understand their customers better, and help them manage their risks prudently.

KYC levels reflect how well Paga knows a Customer. Requirements for these levels are dictated by the regulatory body, Central Bank of Nigeria (CBN), and are based on the information a customer provides to Paga.


Info
titleNotice

This api uses the Basic Authorization header as defined on RFC 2617[2]. You must put the Authorization header which contains your principal and credential separated by ':' and encoded in base 64.


2. Operations

There are several ways to call this API.

POST Multiple customer identifier in request BODY
URL
https://mypaga.com/paga-webservices/kyc/v1/status
HeadersBasic Authorization header with client id and password
Body{"credentials":["+234xxxxxxxxxx","+234xxxxxxxxx","demousername", "demo@customeremail.com"]}
Sample Response
{
    "userDetails": [{
            "credential": "+234xxxxxxxxxx",
            "firstName": "xxxxxxxxxxx",
            "lastName": null,
            "pagaAccountNumber": "123245123"
            "dateOfBirth": null,
            "gender": "male",
            "kycStatus": "KYC Level 1",
            "errorMessage": null
        },
        {
            "credential": "demousername",
            "firstName": "Some",
            "lastName": "Name",
            "kycStatus": "KYC Level 2",
            "pagaAccountNumber": "123245123"
            "dateOfBirth": "1994/03/01",
            "gender": "male",
            "errorMessage": null
        },
        {
            "credential": "demo@customeremail.com",
            "firstName": null,
            "lastName": null,
            "kycStatus": null,
            "pagaAccountNumber": null "dateOfBirth": null,
            "gender": null,
            "errorMessage": "There is no account associated with the credential (demo@customeremail.com)"
        }
    ],
    "message": "completed",
    "errorMessage": null,
    "responseCode": 0
}



GET with customer identifiers in url
URL
https://mypaga.com/paga-webservices/kyc/v1/status/credentials/customer1,+234xxxxxxxx
HeadersBasic Authorization header with client id and password
Request TypeGET
Sample Response


{
    "userDetails": [{
            "credential": "+234xxxxxxxxxx",
            "firstName": "xxxxxxxxxxx",
            "lastName": null,
            "kycStatus": "KYC Level 1",
            "pagaAccountNumber": "123245123"
            "dateOfBirth": "1994/03/01",
            "gender": "female",
            "errorMessage": null
        },
        {
            "credential": "customer1",
            "firstName": null,
            "lastName": null,
            "kycStatus": null,
            "pagaAccountNumber": null "dateOfBirth": null,
            "gender": null,
            "errorMessage": "There is no account associated with the credential (customer1)"
        }
    ],
    "message": "completed",
    "errorMessage": null,
    "responseCode": 0
}




Warning

This API currently only supports JSON Requests and Responses.


You need to get special permission to get access to dateOfBirth response parameter.

session.getFlow() != USSDFlow.VERIFY_TRANSACTION



Panel

On this page:

Table of Contents



Related pages

Filter by label (Content by label)
showLabelsfalse
spacesKYC
showSpacefalse
sorttitle
typepage
cqllabel = "documentation-space-sample" and type = "page" and space = "KYC"
labelsdocumentation-space-sample