# Validate Verification

Validate Verification through this project environment’s SafeHaven account. Uses snake_case fields and NGN minor units. Requires identity:write.

## Endpoint

POST https://api.veyqo.org/api/v1/safehaven/identity/validate

Server secret key required. Scope: identity:write. The key determines the project and environment; no project-selection header is accepted.

> For each new operation, generate and persist one OPERATION_IDEMPOTENCY_KEY. Retry the unchanged request with that same key. Do not generate a new key on every retry.

## Example request

Examples use illustrative IDs and provider URLs. Replace path variables with IDs returned by your own requests. Never paste a live secret into client code or a public tool.

### cURL

```bash
curl --request POST "https://api.veyqo.org/api/v1/safehaven/identity/validate" \
  --header "Authorization: Bearer $VEYQO_SECRET_KEY" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: $OPERATION_IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "identity_id": "000000000000000000000001",
  "type": "BVN",
  "otp": "example"
}'
```

### Node.js

```javascript
// Server-side Node.js 18+. Save operation.idempotencyKey before a write.
const response = await fetch(`https://api.veyqo.org/api/v1/safehaven/identity/validate`, {
  method: 'POST',
  headers: {
  "Authorization": `Bearer ${process.env.VEYQO_SECRET_KEY}`,
  "Accept": "application/json",
  "Idempotency-Key": operation.idempotencyKey,
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "identity_id": "000000000000000000000001",
  "type": "BVN",
  "otp": "example"
}),
});
const result = await response.json();
if (!response.ok || !result.success) {
  console.error(response.status, result.error?.code, response.headers.get('X-Request-Id'));
  throw new Error(result.error?.message ?? 'Veyqo request failed');
}
console.log(result.data);
```

### PHP

```php
<?php
// Server-side PHP with the cURL extension. Persist $operationIdempotencyKey.
$curl = curl_init('https://api.veyqo.org/api/v1/safehaven/identity/validate');
curl_setopt_array($curl, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer '.getenv('VEYQO_SECRET_KEY'),
    'Accept: application/json',
    'Idempotency-Key: '.$operationIdempotencyKey,
    'Content-Type: application/json'
  ],
  CURLOPT_POSTFIELDS => <<<'JSON'
{
  "identity_id": "000000000000000000000001",
  "type": "BVN",
  "otp": "example"
}
JSON,
]);
$body = curl_exec($curl);
if ($body === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
$result = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
if ($status >= 400 || !($result['success'] ?? false)) {
  throw new RuntimeException($result['error']['code'] ?? 'Veyqo request failed');
}
print_r($result['data']);
```

### Python

```python
# pip install requests; run on your server.
import os, requests
from urllib.parse import quote

response = requests.request('POST', f'https://api.veyqo.org/api/v1/safehaven/identity/validate',
    headers={
  "Authorization": 'Bearer ' + os.environ['VEYQO_SECRET_KEY'],
  "Accept": "application/json",
  "Idempotency-Key": operation_idempotency_key,
  "Content-Type": "application/json"
},
    json={
  "identity_id": "000000000000000000000001",
  "type": "BVN",
  "otp": "example"
},
    timeout=30)
result = response.json()
if not response.ok or not result.get('success'):
    raise RuntimeError(f"{response.status_code} {result.get('error')} request_id={response.headers.get('X-Request-Id')}")
print(result['data'])
```

## Request body

| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| identity_id | string | Required | The `_id` you captured from the initial request. |
| type | string | Required | Specify the type of verification (either BVN or NIN). Values: BVN, NIN. |
| otp | string | Required | The OTP that was sent to the customer’s phone number. |

## Successful response · 200

HTTP success means the request was accepted. A pending payment or refund is not completed merely because the response is 200 or 201.

```json
{
  "success": true,
  "data": {
    "_id": "000000000000000000000001",
    "client_id": "000000000000000000000001",
    "identity_number": "example",
    "type": "example",
    "amount": 50000,
    "status": "Created",
    "debit_account_number": "example",
    "vat": 0,
    "stamp_duty": 0,
    "is_deleted": false,
    "otp_verified": false,
    "otp_resend_count": 0,
    "created_at": "example",
    "updated_at": "example",
    "__v": 0,
    "debit_message": "example",
    "debit_respons_code": 0,
    "debit_session_id": "000000000000000000000001",
    "otp_id": "000000000000000000000001",
    "provider_response": {
      "bvn": "example",
      "full_name": "example",
      "first_name": "example",
      "middle_name": "example",
      "last_name": "example",
      "date_of_birth": "example",
      "phone_number1": "+2348000000000",
      "phone_number2": "+2348000000000",
      "gender": "example",
      "enrollment_bank": "example",
      "enrollment_branch": "example",
      "email": "customer@example.com",
      "lga_of_origin": "example",
      "lga_of_residence": "example",
      "marital_status": "example",
      "nin": "example",
      "nationality": "example",
      "residential_address": "example",
      "state_of_origin": "example",
      "state_of_residence": "example",
      "title": "example",
      "watch_listed": "example",
      "level_of_account": "example",
      "registration_date": [],
      "image_base64": "example"
    },
    "operation_id": "pso_01M6EB66SC61Q3RQYAN0693DGM"
  }
}
```

## Response fields

| Field in data | Type | Presence | Description |
| --- | --- | --- | --- |
| _id | string | Optional | See the JSON example. |
| client_id | string | Optional | See the JSON example. |
| identity_number | string | Optional | See the JSON example. |
| type | string | Optional | See the JSON example. |
| amount | integer | Optional | Amount in NGN minor units (kobo). |
| status | string | Optional | See the JSON example. |
| debit_account_number | string | Optional | See the JSON example. |
| vat | integer | Optional | Amount in NGN minor units (kobo). |
| stamp_duty | integer | Optional | Amount in NGN minor units (kobo). |
| is_deleted | boolean | Optional | See the JSON example. |
| otp_verified | boolean | Optional | See the JSON example. |
| otp_resend_count | integer | Optional | See the JSON example. |
| created_at | string | Optional | See the JSON example. |
| updated_at | string | Optional | See the JSON example. |
| __v | integer | Optional | See the JSON example. |
| debit_message | string | Optional | See the JSON example. |
| debit_respons_code | integer | Optional | See the JSON example. |
| debit_session_id | string | Optional | See the JSON example. |
| otp_id | string | Optional | See the JSON example. |
| provider_response | object | Optional | See the JSON example. |
| provider_response.bvn | string | Optional | See the JSON example. |
| provider_response.full_name | string | Optional | See the JSON example. |
| provider_response.first_name | string | Optional | See the JSON example. |
| provider_response.middle_name | string | Optional | See the JSON example. |
| provider_response.last_name | string | Optional | See the JSON example. |
| provider_response.date_of_birth | string | Optional | See the JSON example. |
| provider_response.phone_number1 | string | Optional | See the JSON example. |
| provider_response.phone_number2 | string | Optional | See the JSON example. |
| provider_response.gender | string | Optional | See the JSON example. |
| provider_response.enrollment_bank | string | Optional | See the JSON example. |
| provider_response.enrollment_branch | string | Optional | See the JSON example. |
| provider_response.email | string | Optional | See the JSON example. |
| provider_response.lga_of_origin | string | Optional | See the JSON example. |
| provider_response.lga_of_residence | string | Optional | See the JSON example. |
| provider_response.marital_status | string | Optional | See the JSON example. |
| provider_response.nin | string | Optional | See the JSON example. |
| provider_response.nationality | string | Optional | See the JSON example. |
| provider_response.residential_address | string | Optional | See the JSON example. |
| provider_response.state_of_origin | string | Optional | See the JSON example. |
| provider_response.state_of_residence | string | Optional | See the JSON example. |
| provider_response.title | string | Optional | See the JSON example. |
| provider_response.watch_listed | string | Optional | See the JSON example. |
| provider_response.level_of_account | string | Optional | See the JSON example. |
| provider_response.registration_date | JSON | Optional | See the JSON example. |
| provider_response.image_base64 | string | Optional | See the JSON example. |
| operation_id | string | Optional | Veyqo pso_ operation ID. Save it to reconcile retries and match provider_service.updated events. |
| merchant_reference | string | Optional | Your external_reference or payment_reference, if supplied. SafeHaven receives a globally unique Veyqo reference for supported writes. |

## Errors and recovery

| Code | HTTP | Recovery | Retry policy |
| --- | --- | --- | --- |
| VALIDATION_FAILED | 422 | Read error.details when present, correct the named fields and retry only after correction. Validation messages may describe state/capability errors without field details. | No automatic retry. |
| INVALID_API_KEY | 401 | Use a current kc_test_ or kc_live_ secret key on /api/v1. Use a pk_test_ or pk_live_ publishable key only on browser checkout. | After fixing credentials. |
| INSUFFICIENT_PERMISSION | 403 | Grant the required scope or use a suitably scoped key. Dashboard organization roles and staff permissions are separate. | After permission changes. |
| RESOURCE_NOT_FOUND | 404 | Check the ID, project and environment. Do not guess another project’s IDs. An inactive payment link is also not-found. | No blind retry. |
| PROVIDER_NOT_CONNECTED | 422 | Connect a provider, choose the project default, or explicitly pass provider. An account shared with another project still needs its own assignment here. | After configuration changes. |
| PROVIDER_AUTHENTICATION_FAILED | 502 | The merchant must check/rotate the provider credentials in the dashboard. Do not expose those secrets to your application users. | After credential correction; reconcile existing payment first. |
| PROVIDER_REQUEST_FAILED | 422 | Read the safe message, inspect the payment’s failure details and correct the request or provider account. Never repeatedly retry a business rejection. | Only after resolving the cause. |
| PROVIDER_UNAVAILABLE | 503 | Check the existing payment and verify its state before starting another attempt. Retry safe reads with backoff; preserve operation identity for retried writes. | Conditional: reconcile unknown outcomes first. |
| RATE_LIMIT_EXCEEDED | 429 | Honor Retry-After, use bounded exponential backoff with jitter, and reduce concurrent requests. Read X-RateLimit headers. | Yes, after Retry-After; preserve write idempotency. |
| IDEMPOTENCY_KEY_REUSED | 409 | Reuse the exact original request to recover that operation, or use a new key only for a genuinely different operation. | Do not retry a changed body with that key. |
| IDEMPOTENCY_IN_PROGRESS | 409 | Wait briefly, retry with the same key and unchanged request, then reconcile by reference if the result remains uncertain. | Back off with jitter; preserve key/body. |

- [Complete error catalogue](https://veyqo.org/docs/errors): Every Veyqo error code, including which surface emits it and how to recover.