POST api/AddressBook/ValidateBvnNumber

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
businessId	integer	None.
roleId	integer	None.
bvnNumber	string	None.

Request Formats

application/json, text/json

Sample:

{
  "businessId": 1,
  "roleId": 2,
  "bvnNumber": "sample string 3"
}

application/xml, text/xml

Sample:

<ValidateBvnNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <businessId>1</businessId>
  <roleId>2</roleId>
  <bvnNumber>sample string 3</bvnNumber>
</ValidateBvnNumber>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/28 14:07:41",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>1</StatusCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
</VCAPIResponse>