API reference
Identity
Verify a customer’s BVN (or other supported identity) with an OTP before opening a wallet for them.
Complete an identity verification with the customer's OTP
POST/api/partner/v1/identity/complete-verification
Body
- identity_verification_idstring (uuid)required
idreturned by initiate-verification. Must be one you started. - otpintegerrequired
The OTP the customer received.
Example:
123456
Responses
- 201Verification result; check `data.status`
- 401Missing, invalid or expired access token.
unauthenticated - 422A field failed validation.
validation_failed - 502An upstream bank, biller or identity provider failed. Safe to retry; send the same Idempotency-Key where the endpoint supports one.
provider_error
curl -X POST https://staging.lint.finance/api/partner/v1/identity/complete-verification \
-H "Authorization: Bearer $LINT_ACCESS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"identity_verification_id": "9d3c1f0a-5b2e-4c7a-9f10-2b3c4d5e6f70",
"otp": 123456
}'Response · 201
{
"data": {
"id": "6b1f8a52-2d0f-4e8b-9c33-0a7f5f0e9d21",
"type": "bvn",
"status": "PENDING",
"identity": {}
}
}Start verifying a customer's identity
POST/api/partner/v1/identity/initiate-verification
Starts a BVN (or other supported identity) check for one of your customers. The provider sends the customer an OTP; pass it to complete-verification with the returned id. Attach the verified identity when creating the customer.
Body
- typestringrequired
Identity type code.
Example:
"bvn" - country_codestringrequired
ISO 3166-1 alpha-2 country code.
Example:
"NG" - valuestringrequired
The identity number. Validated per type (a BVN is 11 digits).
Example:
"22212345678"
Responses
- 201Verification started; an OTP has been sent to the customer
- 401Missing, invalid or expired access token.
unauthenticated - 422A field failed validation.
validation_failed - 502An upstream bank, biller or identity provider failed. Safe to retry; send the same Idempotency-Key where the endpoint supports one.
provider_error
curl -X POST https://staging.lint.finance/api/partner/v1/identity/initiate-verification \
-H "Authorization: Bearer $LINT_ACCESS_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"type": "bvn",
"country_code": "NG",
"value": "22212345678"
}'Response · 201
{
"data": {
"id": "6b1f8a52-2d0f-4e8b-9c33-0a7f5f0e9d21",
"type": "bvn",
"status": "PENDING",
"identity": {}
}
}