Login to Institution

This endpoint logs in a user to their selected financial institution.

API Object

// Succesfully logged in.

{
  "status": 200,
    "responseCode": 99,
    "data": {
      "code": "code_euTJM7yOuohSpSFVoBtc"
    }
}

// Requires user input to select the account. [200]

{
  "status": 200,
  "responseCode": 101,
    "data": [
        {
            "accountNumber": "0001557338",
            "name": "NAME ON ACCOUNT",
            "type": "CURRENT_ACCOUNT",
            "currency": "NGN",
            "status": "active",
            "balance": 14457
        },
        ...accounts
  ]
}

// Requires answer from Security question
{
    "status": 200,
    "responseCode": 102,
    "data": {
      "title": "Kindly Answer Your Security Question",
      "form": [
      {
        "type": "elements.input",
        "name": "answer",
        "hint": "Which city were you born in ?",
        "contentType": "string"
      }
      ]
    }
}

Login to Institution Fields (if responseCode is 99)

Field

Description

Type

status

Status code

integer

responseCode

A response code which is either 99, 101 or 102

integer

data

A data object containing an auth. code

object

code

Temporary authorisation code

string

Login to Institution Fields (if responseCode is 101)

Field

Description

Type

status

Status code

integer

responseCode

A response code which is either 99, 101 or 102

integer

data

An array of object which returns all found accounts

array

data[0].accountNumber

Account number of the returned account

string

data[0].name

Account name of the returned account

string

data[0].type

Account type of the returned account

string

data[0].currency

Currency of the returned account

string

data[0].status

The current state of the returned account

string

data[0].balance

Account balance of the returned account

integer


Did this page help you?