Verify Entity (KYC)

curl --request POST \
  --url https://api.youverify.co/v2/api/entities/identity \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "entityType": "individual",
  "isSubjectConsent": true,
  "identity": {
    "id": "A11111111",
    "countryCode": "NG",
    "idType": "bvn",
    "premiumBVN": false
  }
}
'

import requests

url = "https://api.youverify.co/v2/api/entities/identity"

payload = {
    "entityType": "individual",
    "isSubjectConsent": True,
    "identity": {
        "id": "A11111111",
        "countryCode": "NG",
        "idType": "bvn",
        "premiumBVN": False
    }
}
headers = {
    "token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityType: 'individual',
    isSubjectConsent: true,
    identity: {id: 'A11111111', countryCode: 'NG', idType: 'bvn', premiumBVN: false}
  })
};

fetch('https://api.youverify.co/v2/api/entities/identity', 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.youverify.co/v2/api/entities/identity",
  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([
    'entityType' => 'individual',
    'isSubjectConsent' => true,
    'identity' => [
        'id' => 'A11111111',
        'countryCode' => 'NG',
        'idType' => 'bvn',
        'premiumBVN' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <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.youverify.co/v2/api/entities/identity"

	payload := strings.NewReader("{\n  \"entityType\": \"individual\",\n  \"isSubjectConsent\": true,\n  \"identity\": {\n    \"id\": \"A11111111\",\n    \"countryCode\": \"NG\",\n    \"idType\": \"bvn\",\n    \"premiumBVN\": false\n  }\n}")

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

	req.Header.Add("token", "<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.youverify.co/v2/api/entities/identity")
  .header("token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entityType\": \"individual\",\n  \"isSubjectConsent\": true,\n  \"identity\": {\n    \"id\": \"A11111111\",\n    \"countryCode\": \"NG\",\n    \"idType\": \"bvn\",\n    \"premiumBVN\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.youverify.co/v2/api/entities/identity")

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

request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entityType\": \"individual\",\n  \"isSubjectConsent\": true,\n  \"identity\": {\n    \"id\": \"A11111111\",\n    \"countryCode\": \"NG\",\n    \"idType\": \"bvn\",\n    \"premiumBVN\": false\n  }\n}"

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

{
  "success": true,
  "status_code": 200,
  "message": "Identity check successful!",
  "data": {
    "id": "ent_69da84b4c0ac039957be5439",
    "entity": {
      "entityId": "ent_69da84b4c0ac039957be5439",
      "isNew": false,
      "message": ""
    },
    "identityCheck": {
      "status": "found",
      "firstName": "Sarah",
      "lastName": "Doe",
      "dateOfBirth": "1988-04-04",
      "middleName": "Jane",
      "image": "base64 image",
      "phone": "08000000000",
      "email": null,
      "gender": "Female",
      "adverseMediaReport": null,
      "amlReport": null,
      "type": "nin",
      "nationality": "NG",
      "idNumber": "11111111111",
      "businessId": "69b3c7f1556f687f7fb8a5bd",
      "parentId": null,
      "requestedBy": {
        "firstName": "Jamal",
        "lastName": "Akinyelu",
        "middleName": "",
        "id": "69b3c7f6556f687f7fb8a5c7"
      },
      "isExpired": false,
      "reason": null,
      "verificationId": "69da8ae76398f3a575c950e0"
    }
  },
  "links": []
}

{
  "success": true,
  "status_code": 201,
  "message": "Business check successful!",
  "data": {
    "id": "69dab502682626b4e9e6d77c",
    "entity": {
      "entityId": "ent_69dab0119abad240d91071a4",
      "isNew": true,
      "message": "Entity created successfully."
    },
    "businessCheck": {
      "id": "69dab502682626b4e9e6d77c",
      "status": "found",
      "businessId": "69b3c7f1556f687f7fb8a5bd",
      "parentId": null,
      "isConsent": true,
      "type": "basic_company_check",
      "searchTerm": "RC00000000",
      "name": "John Doe Inc",
      "registrationNumber": "RC00000000",
      "companyStatus": "ACTIVE",
      "requestedAt": "2026-04-11T20:54:27.818Z",
      "country": "Nigeria",
      "createdAt": "2022-11-03T14:16:54.235Z",
      "lastModifiedAt": "2022-11-03T14:16:54.235Z",
      "typeOfEntity": "PRIVATE COMPANY LIMITED BY SHARES",
      "registrationDate": "2017-06-09",
      "natureOfBusiness": null,
      "amlReport": null,
      "adverseMediaReport": null,
      "requestedBy": {
        "firstName": "Jamal",
        "lastName": "Akinyelu",
        "middleName": "",
        "id": "69b3c7f6556f687f7fb8a5c7"
      }
    }
  }
}

{
  "success": false,
  "statusCode": 401,
  "message": "Permission denied",
  "name": "UnauthorizedError",
  "data": {}
}

{
  "success": false,
  "statusCode": 402,
  "message": "Insufficient fund",
  "name": "PaymentRequiredError",
  "data": {}
}

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}

{
  "success": false,
  "statusCode": 429,
  "message": "Too many requests",
  "name": "RateLimitError",
  "data": {}
}

{
  "success": false,
  "statusCode": 500,
  "message": "Internal Server Error",
  "name": "Error",
  "data": {}
}