Skip to main content
POST
/
identity
Create identity
curl --request POST \
  --url https://processor-prod.up.railway.app/identity \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "type": "BVN",
  "name": "John Doe",
  "details": {
    "bvn": "1234567890",
    "dob": "01-05-1990"
  }
}
'
{
  "success": true,
  "status": 201,
  "message": "Identity created successfully",
  "timestamp": "2025-09-08T19:26:31.532Z",
  "data": {
    "id": "68bf2de7196a18d7bd165ffb",
    "link": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
type
enum<string>
required

Type of identity verification

Available options:
BVN,
NIN,
Link
Example:

"BVN"

​
name
string
required

Full name of the identity holder

Example:

"John Doe"

​
details
BVN · object
required

Identity details based on type

Response

201 - application/json

Identity created successfully

​
success
boolean
Example:

true

​
status
integer
Example:

201

​
message
string
Example:

"Identity created successfully"

​
timestamp
string<date-time>
Example:

"2025-09-08T19:26:31.532Z"

​
data
object