---
agentTools:
  projectIndex: https://developers.burodeingresos.com/llms.txt
---

# 🚀 Added External ID support for verifications

**External ID Support for Verifications**

* Added optional `external_id` field to verification requests for better tracking and correlation with your internal systems
* Supports both single and bulk verification endpoints
* External ID is returned in verification responses when provided

**Single Verification Example:**

```json
// Request
{
  "identifier": "ABCD123456DEFGHI01",
  "external_id": "USER_12345_VERIFICATION_001"
}

// Response
{
  "id": "01998266-53cd-708a-b93b-7a1868b94ec5",
  "identifier": "ABCD123456DEFGHI01",
  "status": "in_progress",
  "consent_id": "01998266-4cc2-78e1-bfd5-37ba4a5bad2c",
  "created_at": "2025-09-25T19:42:48.269024839Z",
  "external_id": "USER_12345_VERIFICATION_001"
}
```

**New Bulk Verification Status Endpoint**

* New endpoint: `GET /verifications/bulk/bulk_id`
* Track the progress of your bulk verification jobs in real-time
* Get detailed metrics including total, completed, and in-progress counts

**Example Response:**

```json
{
  "metrics": {
    "total": 100,
    "completed": 100,
    "in_progress": 0
  },
  "bulk_id": "cd9441c8-6eab-4343-be54-329dc0cad139",
  "created_at": "2025-09-18T09:47:09.497623Z"
}
```

<br />

**Updated Webhook Notifications**

Webhook payloads now include the external\_id field for better correlation with your internal systems
The external ID will be included in verification completion notifications when provided during verification creation.

**Example Webhook Payload:**

```json
{
  "event": "verification.completed",
  "verification_id": "bd830637-ea6e-4888-80ab-a09f01fc9209",
  "identifier": "OICE940722HGFRST08",
  "status": "completed",
  "data_available": true,
  "can_retry": false,
  "entities": ["profile","employment", "invoices"],
  "last_updated_at": "2025-04-29T10:37:25Z",
  "timestamp": "2025-04-29T10:37:25Z",
  "external_id": "USER_12345_VERIFICATION_001"
}
```

<br />