Submit customer KYC 🔒

curl --request POST \
  --url https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc \
  --header 'Content-Type: application/json' \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>' \
  --data '
{
  "type": "<string>",
  "payload": {},
  "bvn": "<string>"
}
'

import requests

url = "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc"

payload = {
    "type": "<string>",
    "payload": {},
    "bvn": "<string>"
}
headers = {
    "X-Numero-Api-Key": "<api-key>",
    "X-Numero-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Numero-Api-Key': '<api-key>',
    'X-Numero-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({type: '<string>', payload: {}, bvn: '<string>'})
};

fetch('https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => '<string>',
    'payload' => [
        
    ],
    'bvn' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Numero-Api-Key: <api-key>",
    "X-Numero-Signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Numero-Api-Key", "<api-key>")
	req.Header.Add("X-Numero-Signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc")
  .header("X-Numero-Api-Key", "<api-key>")
  .header("X-Numero-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "businessCode": "<string>",
    "externalId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "country": "<string>",
    "dateOfBirth": "2023-11-07T05:31:56Z",
    "kycTier": 123,
    "kycStatus": "<string>",
    "kycVerifiedAt": "2023-11-07T05:31:56Z",
    "capabilities": [
      "<string>"
    ],
    "status": "<string>",
    "isTest": true,
    "metadataJson": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "cardProfile": {
      "cardCustomerId": "<string>",
      "status": "<string>",
      "activeCardCount": 123
    },
    "billingProfile": {
      "id": 123,
      "name": "<string>",
      "type": "<string>",
      "address": "<string>"
    }
  },
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

POST

customers

{id}

kyc

Submit customer KYC 🔒

curl --request POST \
  --url https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc \
  --header 'Content-Type: application/json' \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>' \
  --data '
{
  "type": "<string>",
  "payload": {},
  "bvn": "<string>"
}
'

import requests

url = "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc"

payload = {
    "type": "<string>",
    "payload": {},
    "bvn": "<string>"
}
headers = {
    "X-Numero-Api-Key": "<api-key>",
    "X-Numero-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Numero-Api-Key': '<api-key>',
    'X-Numero-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({type: '<string>', payload: {}, bvn: '<string>'})
};

fetch('https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => '<string>',
    'payload' => [
        
    ],
    'bvn' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Numero-Api-Key: <api-key>",
    "X-Numero-Signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc"

	payload := strings.NewReader("{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Numero-Api-Key", "<api-key>")
	req.Header.Add("X-Numero-Signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc")
  .header("X-Numero-Api-Key", "<api-key>")
  .header("X-Numero-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usenumero.com/numeroaccount/api/v1/customers/{id}/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Numero-Api-Key"] = '<api-key>'
request["X-Numero-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"<string>\",\n  \"payload\": {},\n  \"bvn\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "businessCode": "<string>",
    "externalId": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "country": "<string>",
    "dateOfBirth": "2023-11-07T05:31:56Z",
    "kycTier": 123,
    "kycStatus": "<string>",
    "kycVerifiedAt": "2023-11-07T05:31:56Z",
    "capabilities": [
      "<string>"
    ],
    "status": "<string>",
    "isTest": true,
    "metadataJson": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "cardProfile": {
      "cardCustomerId": "<string>",
      "status": "<string>",
      "activeCardCount": 123
    },
    "billingProfile": {
      "id": 123,
      "name": "<string>",
      "type": "<string>",
      "address": "<string>"
    }
  },
  "error": {
    "message": "<string>",
    "param": "<string>"
  },
  "meta": {
    "request_id": "<string>",
    "pagination": {
      "page": 123,
      "page_size": 123,
      "total": 123,
      "has_more": true
    }
  }
}

Authorizations

X-Numero-Api-Key

string

header

required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

X-Numero-Signature

string

header

required

Base64(HMAC-SHA256(publicApiKey, input)) over the raw request body (POST) or canonicalized query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on money-movement / state-changing endpoints (marked 🔒).

The HMAC key is your Public Key as raw UTF-8 bytes — a SECRET despite the name, and a different value from the X-Numero-Api-Key authentication header. Signing with the API key will never produce a valid signature.

Path Parameters

integer<int64>

required

Body

application/json

Give type plus the matching identifier in payload. A bare { "bvn": "..." } body is still accepted for back-compatibility and is treated as a BVN check.

type

string

Verification product code, e.g. BVN or NIN.

payload

object

Identifiers for the check, e.g. { "bvn": "22222222222" }.

Show child attributes

bvn

string

Back-compat shorthand for a BVN check.

Response

The customer

Canonical response envelope for the public surface. data on success, error on failure.

data

object

required

One customer, with everything they own attached.

Show child attributes

error

object | null

required

Show child attributes

Utilities

Balance

Cards

Cardholders

Transfers

Virtual Accounts

Airtime

Data

Electricity

Cable TV

Betting

Verification

Credit

Customers

Invoices

Sandbox

Customer Wallets

API Reference

Submit customer KYC 🔒

Authorizations

Path Parameters

Body

Response