Asynchronous bulk jobs for high-volume data retrieval and matching.
Make your first request
Use this guide to move from authentication to a valid Asynchronous (Batch) API request, then open each endpoint guide for the full request and response details.
Get an access token
Use the authentication flow for your workspace and send the token as a Bearer credential.
Read the response
Check the status, content type, and documented response fields before processing results.
GET /job/{jobId}
Endpoint guides explain URL parameters, headers, request bodies, and required values.
Endpoint guides pair a response example with the generated technical schema so implementation and validation stay together.
Asynchronous (Batch) API
Run larger matching and enrichment workloads through job-based operations. Create a job, poll its status, and follow the generated endpoint specifications for request and response details.
Overview
The batch API is designed for workloads that are too large or too slow for a single synchronous request. The API returns a job ID so your application can track progress and continue other work while processing completes.
Start a job
Submit the batch request and retain the returned job ID with your application’s job record.
Monitor progress
Poll the status endpoint using the job ID until the service reports the next available state or result.
Handle the result
Use the endpoint response and generated schemas to process returned matches or enrichment data.
Workflow
Design batch processing as a durable workflow: create the job, persist the job ID, poll with backoff, and handle success, failure, and retry states explicitly. The child endpoint pages below are the source of truth for the exact payloads and response schemas.
Store the job ID, request scope, timestamps, and final status so operators can troubleshoot delayed or failed processing without resubmitting blindly.
Endpoint tech specs
Open a child page for each generated technical specification.
Create a Bulk Data Retrieval Job
Submit a bulk data retrieval job and receive the job identifier needed for status checks.
View endpoint tech specs →Get Bulk Job Status
Poll a bulk job by ID to monitor processing state and retrieve the available job response.
View endpoint tech specs →Match Companies and Contacts in Bulk
Submit a company and contact matching job for asynchronous processing.
View endpoint tech specs →Operational notes
Authentication
Use the bearer token required by the B2B API and keep it out of client-side code and logs.
Correlation
Treat the returned job ID as the correlation key for polling, support diagnostics, and result handling.
Failure handling
Use the generated endpoint error responses to distinguish validation, authorization, rate-limit, and processing failures.