Skip to main content
POST
/
sourcing
/
enrich
Initiate enrichment run
curl --request POST \
  --url https://api.instaview.sk/sourcing/enrich \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "profileIds": [
    "profile_abc123",
    "profile_def456"
  ],
  "webhookId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "success": true,
  "requestId": "enr_550e8400-e29b-41d4-a716-446655440000",
  "status": "processing",
  "message": "Enrichment run accepted and queued for processing.",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "webhookId": "123e4567-e89b-12d3-a456-426614174000"
}

Documentation Index

Fetch the complete documentation index at: https://docs.instaview.sk/llms.txt

Use this file to discover all available pages before exploring further.

Submits a batch of candidate profile IDs for deep enrichment. Returns immediately with a requestId and status: "processing". Results are delivered via webhook or polled at GET /sourcing/enrich//results.

​
Overview

Enrichment performs a deep background evaluation of each profile against external indexing platforms, scrapes publicly available portfolios, and attempts to discover verified email contact addresses. Each successfully enriched profile consumes 1 credit.

​
Resilience Behaviour

  • Per-profile timeout: 10 seconds per candidate.
  • Isolated failures: if a single profile times out or fails, it is isolated and marked as failed. The remaining profiles in the batch continue processing.
  • Billing: only successfully enriched profiles are billed.

​
Billing Pre-Flight

  • Prepaid accounts: your credit balance must be ≥ the number of requested profile IDs. If insufficient, the API returns 402 Payment Required before any enrichment starts.
  • Postpaid accounts: the run starts immediately; credits are recorded and invoiced at end of the billing cycle.

​
Webhook Delivery

Pass a webhookId referencing a WebhookConfig that subscribes to at least one of ENRICH_COMPLETED or ENRICH_FAILED. The webhook config must belong to the same company as the API key.

​
Examples

​
Request

{
  "profileIds": ["prof_a9238f82-a723", "prof_e8321c12-b912"],
  "webhookId": "3f9a12c7-44b8-4d32-b71f-e29a7d1e0f5c"
}

​
Response (202 Accepted)

{
  "success": true,
  "requestId": "enr_550e8400-e29b-41d4-a716-446655440001",
  "status": "processing",
  "message": "Enrichment run accepted and queued for processing.",
  "webhookId": "3f9a12c7-44b8-4d32-b71f-e29a7d1e0f5c",
  "createdAt": "2026-05-20T13:21:00.000Z"
}

​
Error Responses

​
402 — Insufficient Credits (Prepaid)

{
  "statusCode": 402,
  "error": "INSUFFICIENT_FUNDS",
  "message": "Insufficient credits. Need 2, have 0."
}

​
422 — Webhook Not Subscribed to Enrichment Events

{
  "statusCode": 422,
  "error": "WEBHOOK_EVENT_NOT_SUBSCRIBED",
  "message": "Webhook configuration must subscribe to at least one enrich event (ENRICH_COMPLETED or ENRICH_FAILED)."
}

Authorizations

​
Authorization
string
header
required

API key for authentication using Bearer scheme

Body

application/json
​
profileIds
string[]
required

Array of profile IDs to enrich. Maximum 10 per request.

Required array length: 1 - 10 elements
Example:
["profile_abc123", "profile_def456"]
​
webhookId
string<uuid>

UUID of a WebhookConfig to notify when the enrichment run completes or fails. The webhook must belong to the same company and subscribe to at least one enrich event (ENRICH_COMPLETED or ENRICH_FAILED).

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Enrichment run accepted and queued for processing

​
success
boolean
required

Whether the request was accepted for processing.

Example:

true

​
requestId
string
required

Unique identifier for this enrichment run.

Example:

"enr_550e8400-e29b-41d4-a716-446655440000"

​
status
enum<string>
required

Current status of the enrichment run.

Available options:
processing,
completed,
failed
Example:

"processing"

​
message
string
required

Human-readable message.

Example:

"Enrichment run accepted and queued for processing."

​
createdAt
string
required

ISO 8601 timestamp when the run was created.

Example:

"2025-01-01T00:00:00.000Z"

​
webhookId
string

UUID of the webhook configuration that will receive completion events.

Example:

"123e4567-e89b-12d3-a456-426614174000"