POST internal/GetBvnDetails

Fetches BVN details from NIBSS

Request Information

URI Parameters

None.

Body Parameters

BvnDetailsRequest
NameDescriptionTypeAdditional information
request_id

string

None.

bvn_number

string

None.

modulename

string

None.

Request Formats

application/json, text/json

Sample:
{
  "request_id": "sample string 1",
  "bvn_number": "sample string 2",
  "modulename": "sample string 3"
}

application/xml, text/xml

Sample:
<BvnDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sales_portal_common">
  <bvn_number>sample string 2</bvn_number>
  <modulename>sample string 3</modulename>
  <request_id>sample string 1</request_id>
</BvnDetailsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BvnDetailsRequest'.

Response Information

Resource Description

BvnDetailsResponse
NameDescriptionTypeAdditional information
first_name

string

None.

last_name

string

None.

middle_name

string

None.

phone

string

None.

date_of_birth

string

None.

request_id

string

None.

response_id

string

None.

enrollment_bank

string

None.

enrollment_branch

string

None.

response_descr

string

None.

response_code

string

None.

full_description

string

None.

DisplayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "first_name": "sample string 1",
  "last_name": "sample string 2",
  "middle_name": "sample string 3",
  "phone": "sample string 4",
  "date_of_birth": "sample string 5",
  "request_id": "sample string 6",
  "response_id": "sample string 7",
  "enrollment_bank": "sample string 8",
  "enrollment_branch": "sample string 9",
  "response_descr": "sample string 10",
  "response_code": "sample string 11",
  "full_description": "sample string 12",
  "DisplayMessage": "sample string 13"
}

application/xml, text/xml

Sample:
<BvnDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/sales_portal_common">
  <DisplayMessage>sample string 13</DisplayMessage>
  <full_description>sample string 12</full_description>
  <response_code>sample string 11</response_code>
  <response_descr>sample string 10</response_descr>
  <date_of_birth>sample string 5</date_of_birth>
  <enrollment_bank>sample string 8</enrollment_bank>
  <enrollment_branch>sample string 9</enrollment_branch>
  <first_name>sample string 1</first_name>
  <last_name>sample string 2</last_name>
  <middle_name>sample string 3</middle_name>
  <phone>sample string 4</phone>
  <request_id>sample string 6</request_id>
  <response_id>sample string 7</response_id>
</BvnDetailsResponse>