Skip to main content

Add BVN

POST /api/v1/Person/add-bvn

Description​

This endpoint is used to add BVN to a person's profile.

Tags:
Person

URL:
/api/v{version}/Person/add-bvn

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
None

Path Parameters:
None

Request Body:

  • content:

    • application/json

    • text/json

    • application/*+json

Response:
Success, returns person details.

Error Codes:

  • 400: Bad Request

  • 404: Not Found

Example:

/api/v1/Person/add-bvn

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "personId": `<uuid>`,
  "bvn": `<string>`
}

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "validBvn": `<boolean>`
  }
}

Response: 400​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

Response: 404​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<string>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Person/add-bvn \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!