> ## Documentation Index > Fetch the complete documentation index at: https://docs.afriex.com/llms.txt > Use this file to discover all available pages before exploring further. # Verify Customer > Runs an identity verification against a customer document. Today the only supported `docType` is `BVN` (Nigeria); `docValue` is the document number. Verification is rate limited per business. Run an identity verification against a customer document. Today the only supported document type is the Nigerian **BVN**; pass it as `docType: "BVN"` with the number in `docValue`. Verification is rate limited per business. If you exceed the limit, the endpoint returns `429 Too Many Requests`. ## OpenAPI ````yaml POST /api/v1/customer/{customerId}/verify openapi: 3.1.0 info: title: Afriex Business API version: 1.0.8 description: >- Welcome to the Afriex Business API. This API allows you to manage customers, process payments, handle payouts, and receive real-time notifications via webhooks. For detailed guidance on authentication, pagination, error handling, and webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in the top bar. The guide provides a step-by-step instructions to help you integrate seamlessly. termsOfService: https://www.afriex.com/terms-and-condition contact: name: Afriex API Support email: eng@afriex.co url: https://docs.afriex.com license: name: Proprietary url: https://www.afriex.com/terms-and-condition servers: - url: https://sandbox.api.afriex.com description: Staging Base URL - url: https://api.afriex.com description: Production Base URL security: - ApiKey: [] tags: - name: Customers description: Create and manage your customers. - name: Payment Methods description: Register and resolve customer payout and collection methods. - name: Transactions description: Create and track deposits, withdrawals, and swaps. - name: Balance description: View and top up your business wallet balances. - name: Rates description: Fetch real-time exchange rates. - name: Checkout Sessions description: Create hosted checkout sessions. - name: Webhooks description: Webhook event payloads and sandbox webhook testing. paths: /api/v1/customer/{customerId}/verify: parameters: - $ref: '#/components/parameters/x-api-version' post: tags: - Customers summary: Verify a customer document description: >- Runs an identity verification against a customer document. Today the only supported `docType` is `BVN` (Nigeria); `docValue` is the document number. Verification is rate limited per business. operationId: verifyCustomer parameters: - name: customerId in: path description: The unique identifier of the customer required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: docType: type: string description: The type of document to verify. enum: - BVN docValue: type: string minLength: 1 description: The document number to verify. required: - docType - docValue examples: bvn: summary: Verify a Nigerian BVN value: docType: BVN docValue: '22222222222' responses: '200': description: Customer verified successfully. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Customer' examples: success: summary: Customer verified value: data: name: Jane Smith email: jane.smith@example.com phone: '+2348192837465' customerId: 69d5ffe1ab82306f11b032f3 countryCode: NG createdAt: '2026-04-08T07:12:33.519Z' updatedAt: '2026-04-08T07:21:09.872Z' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validationError: summary: Validation error value: code: VALIDATION_ERROR error: 'Failed to parse request. Issues: ''docValue'' is required' details: {} '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: code: AUTHENTICATION_ERROR error: Authorization header is missing details: {} invalidApiKey: summary: Invalid API key value: code: AUTHENTICATION_ERROR error: Invalid authorization header details: {} '404': description: Customer not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notFound: summary: Customer not found value: code: BUSINESS_CUSTOMER_NOT_FOUND error: Business customer not found details: errorMessage: Business customer not found friendlyMessage: '' '429': description: Too many verification requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: summary: Rate limit exceeded value: code: RATE_LIMIT_EXCEEDED error: Too many requests, please try again later details: {} '500': description: Server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: serverError: summary: Unexpected server error value: code: INTERNAL_SERVER_ERROR error: It's not you, it's us, please reach out to support details: {} x-codeSamples: - lang: TypeScript label: Afriex SDK source: | const customer = await afriex.customers.verify("customer-id", { docType: "BVN", docValue: "22222222222", }); components: parameters: x-api-version: name: x-api-version in: header required: false description: >- API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest stable. schema: type: string schemas: Customer: type: object properties: customerId: type: string description: The unique identifier for the customer. name: type: string description: The full name of the customer. email: type: string format: email description: The email of the customer. phone: type: string description: The phone number of the customer in E.164 format. countryCode: type: string description: The country code of the customer in ISO 3166-1 alpha-2 format. meta: type: object description: optional meta data you can attach to the customer. createdAt: type: string description: The date and time the customer was created. updatedAt: type: string description: The date and time the customer was last updated. ErrorResponse: type: object properties: code: type: string description: Machine-readable error code. error: type: string description: Human-readable error message. details: $ref: '#/components/schemas/ErrorDetails' ErrorDetails: type: object properties: errorMessage: type: string description: Detailed/technical error message. friendlyMessage: type: string description: User-facing error message safe to display. data: type: object description: >- Optional caller-safe context for the error. On a customer-create uniqueness conflict (EMAIL_ALREADY_EXISTS / PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's id, so you can adopt it without a follow-up lookup. properties: customerId: type: string description: Id of the existing customer (on a create conflict). securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: >- Static business API key issued from the dashboard. A business can provision **multiple API keys**, each scoped to a configurable set of **permissions** (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint will be rejected with a `403 Forbidden` response; an unrecognised, malformed or revoked key returns `401 Unauthorized`. Manage your keys and their permissions under **Developer → API keys** in the dashboard. ````