> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.shimi.cash/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server.

# Verify Entity (Meter / Smartcard)

POST https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity
Content-Type: application/json

Validates a meter number (Utility) or smartcard number (Cable TV) and returns a `meterVerificationId` — required by **Purchase Utility Bill** and **Purchase Cable TV**, and single-use.

**Body (JSON):**

| Field               | Type   | Rules                                                                         |
| ------------------- | ------ | ----------------------------------------------------------------------------- |
| `serviceCategoryId` | string | required, 4–250 chars; must be an active **Utility** or **Cable TV** category |
| `entityNumber`      | string | required, max 250; meter number (Utility) or smartcard/IUC number (Cable TV)  |

Returns a single-use `meterVerificationId` plus the customer name on the account. `type` is `UTILITY` or `CABLE_TV`. For Utility, the meter's vend type (PREPAID/POSTPAID) is stored from the provider and **Purchase Utility Bill** must send the same `vendType`. A verification is consumed by a purchase and released again only if that purchase is refunded. Provider lookup failures return **500**.

**Error format:** body validation failures (Joi) return `{ "status": "error", "message": "Validation error", "details": [ ... ] }`; all other errors return `{ "success": false, "message": "..." }`. Money fields (`amount`, `fee`) are Prisma Decimals and are serialized as **strings** (e.g. `"1000"`).

Reference: https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/verify-entity-meter-smartcard

## Authentication

- `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes).

## Request

### Body (application/json)

This endpoint expects an object.

- `serviceCategoryId` (string, optional)
- `entityNumber` (string, optional)

## Response

### 200

Success (Utility meter) / Success (Cable TV smartcard)

- `success` (boolean, optional)
- `data` (VtuVerifyEntityPostResponsesContentApplicationJsonSchemaData, optional)

## Errors

### 400 Bad Request Error

Validation error / Invalid category / Not verifiable

- `status` (string, optional)
- `message` (string, optional)
- `details` (list of string, optional)
- `success` (boolean, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, optional)

### 403 Forbidden Error

Invalid or expired access token / KYB not approved / Account deactivated

- `message` (string, optional)
- `code` (string, optional)
- `kybStatus` (string, optional)

### 500 Internal Server Error

Internal Server Error

- `success` (boolean, optional)
- `message` (string, optional)

## Types

### VtuVerifyEntityPostResponsesContentApplicationJsonSchemaData

- `meterVerificationId` (string, optional)
- `type` (string, optional)
- `name` (string, optional)

## Examples

### 200 Success (Utility meter)

**Response**

```json
{
  "success": true,
  "data": {
    "meterVerificationId": "cm2y3f6g70003mvr8uv12wx3",
    "type": "UTILITY",
    "name": "ADEBAYO OLUWASEUN"
  }
}
```

**SDK Code**

```python 200 Success (Utility meter)
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript 200 Success (Utility meter)
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Success (Utility meter)
package main

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

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Success (Utility meter)
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java 200 Success (Utility meter)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Success (Utility meter)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Success (Utility meter)
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success (Utility meter)
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### 200 Success (Cable TV smartcard)

**Response**

```json
{
  "success": true,
  "data": {
    "meterVerificationId": "cm2y3f6g70004mvr1yz34ab5",
    "type": "CABLE_TV",
    "name": "CHIOMA OKAFOR"
  }
}
```

**SDK Code**

```python 200 Success (Cable TV smartcard)
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript 200 Success (Cable TV smartcard)
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Success (Cable TV smartcard)
package main

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

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Success (Cable TV smartcard)
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java 200 Success (Cable TV smartcard)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Success (Cable TV smartcard)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Success (Cable TV smartcard)
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success (Cable TV smartcard)
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example

**Request**

```json
{
  "serviceCategoryId": "{{service_category_id}}",
  "entityNumber": "04012345678"
}
```

**Response**

```json
{
  "success": true,
  "data": {
    "meterVerificationId": "cm2y3f6g70003mvr8uv12wx3",
    "type": "UTILITY",
    "name": "ADEBAYO OLUWASEUN"
  }
}
```

**SDK Code**

```python Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

payload = {
    "serviceCategoryId": "{{service_category_id}}",
    "entityNumber": "04012345678"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"serviceCategoryId":"{{service_category_id}}","entityNumber":"04012345678"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
package main

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

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity"

	payload := strings.NewReader("{\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"entityNumber\": \"04012345678\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"entityNumber\": \"04012345678\"\n}"

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

```java Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"entityNumber\": \"04012345678\"\n}")
  .asString();
```

```php Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity', [
  'body' => '{
  "serviceCategoryId": "{{service_category_id}}",
  "entityNumber": "04012345678"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"entityNumber\": \"04012345678\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Airtime, Data & Bills (VTU)_verifyEntityMeterSmartcard_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "serviceCategoryId": "{{service_category_id}}",
  "entityNumber": "04012345678"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/verify-entity")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```