Coverbase

Overview

Introduction

Export API Concepts

Import API Concepts

Getting Started

Base URL

Authentication

API Reference

Export API Reference

Import API Reference

Blank

Coverbase API Documentation

Coverbase API Docs

Production

Sandbox

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><strong class="slate-bold">Coverbase Risk Assessment Copilot</strong></p><p class="slate-p " >Automates approximately 90% of vendor risk assessment workload. TPRM Copilot is an AI-powered assessment engine that replaces manual, spreadsheet-driven workflows with a programmatic pipeline. The API supports custom questionnaire generation, automated control extraction from uploaded evidence (SOC 2s, ISO reports, pen test summaries, policy documents), and real-time vendor response analysis. During reassessments, Copilot performs delta detection against prior assessment state, generates follow-up questions based on response gaps, and flags residual risks for reviewer attention. Consumers can integrate Copilot into onboarding pipelines or continuous compliance workflows to maintain assessment consistency at scale while routing the remaining 10% of edge cases to human reviewers.</p><p class="slate-p " ><strong class="slate-bold">Coverbase Supplier Radar</strong></p><p class="slate-p " >Automates continuous monitoring, triage, and response across the third-party ecosystem. Supplier Radar ingests signals from threat intelligence feeds, public disclosures, sanctions and watchlists, breach databases, regulatory actions, and other external sources. Detected events are normalized, enriched with vendor context, and routed through configurable triage logic into downstream workflows. Rule sequences support severity scoring, deduplication, and assignment to the correct risk owner. The API exposes event streams, subscription management, and workflow state so consumers can stay ahead of third-party breaches, compliance failures, and ecosystem-wide incidents without relying on vendor self-disclosure.</p><p class="slate-p " ><strong class="slate-bold">Coverbase Inspect</strong></p><p class="slate-p " >Agentic, browser-based vendor inspection that performs structured discovery against a vendor&apos;s public and authenticated surface area. Inspect drives a headless browser to validate attestations, extract evidence from trust centers, and capture screenshots and artifacts with full chain-of-custody metadata. The API accepts inspection plans (target domains, evidence types, auth context) and returns structured findings suitable for ingestion into an assessment record. Use Inspect to convert claims into verified control evidence without manual vendor follow-up.</p><p class="slate-p " ><strong class="slate-bold">Coverbase Autonomous Intake</strong></p><p class="slate-p " >Procurement-embedded intake that classifies incoming third-party requests, triggers the appropriate risk path, and orchestrates downstream assessment work. The API accepts free-form intake submissions (requester context, vendor identity, intended use, data types) and returns a classified risk stripe, required control set, and a sequenced workflow. Autonomous Intake removes the manual routing layer between procurement and risk teams and ensures every third-party engagement enters the TPRM program at the correct depth.</p><p class="slate-p " ><strong class="slate-bold">Coverbase Contract Guardian</strong></p><p class="slate-p " >Contract analysis and redline surfacing for third-party agreements. The API accepts contract documents (MSAs, DPAs, SOWs, BAAs) and returns extracted clauses, missing-clause detection, liability and indemnity analysis, AI-usage provisions, and deviations from an organization-defined playbook. Contract Guardian also supports re-evaluation on amendment so the contractual control surface stays aligned with the live risk profile maintained in Supplier Radar.</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100%;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><h4 class="slate-h4 " >🗓️ Need assistance?</h4><p class="slate-p " ><a href="https://calendly.com/cchio/30min" target="_blank">Book a meeting</a></p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

Automates approximately 90% of vendor risk assessment workload. TPRM Copilot is an AI-powered assessment engine that replaces manual, spreadsheet-driven workflows with a programmatic pipeline. The API supports custom questionnaire generation, automated control extraction from uploaded evidence (SOC 2s, ISO reports, pen test summaries, policy documents), and real-time vendor response analysis. During reassessments, Copilot performs delta detection against prior assessment state, generates follow-up questions based on response gaps, and flags residual risks for reviewer attention. Consumers can integrate Copilot into onboarding pipelines or continuous compliance workflows to maintain assessment consistency at scale while routing the remaining 10% of edge cases to human reviewers.

Automates continuous monitoring, triage, and response across the third-party ecosystem. Supplier Radar ingests signals from threat intelligence feeds, public disclosures, sanctions and watchlists, breach databases, regulatory actions, and other external sources. Detected events are normalized, enriched with vendor context, and routed through configurable triage logic into downstream workflows. Rule sequences support severity scoring, deduplication, and assignment to the correct risk owner. The API exposes event streams, subscription management, and workflow state so consumers can stay ahead of third-party breaches, compliance failures, and ecosystem-wide incidents without relying on vendor self-disclosure.

Agentic, browser-based vendor inspection that performs structured discovery against a vendor's public and authenticated surface area. Inspect drives a headless browser to validate attestations, extract evidence from trust centers, and capture screenshots and artifacts with full chain-of-custody metadata. The API accepts inspection plans (target domains, evidence types, auth context) and returns structured findings suitable for ingestion into an assessment record. Use Inspect to convert claims into verified control evidence without manual vendor follow-up.

Procurement-embedded intake that classifies incoming third-party requests, triggers the appropriate risk path, and orchestrates downstream assessment work. The API accepts free-form intake submissions (requester context, vendor identity, intended use, data types) and returns a classified risk stripe, required control set, and a sequenced workflow. Autonomous Intake removes the manual routing layer between procurement and risk teams and ensures every third-party engagement enters the TPRM program at the correct depth.

Contract analysis and redline surfacing for third-party agreements. The API accepts contract documents (MSAs, DPAs, SOWs, BAAs) and returns extracted clauses, missing-clause detection, liability and indemnity analysis, AI-usage provisions, and deviations from an organization-defined playbook. Contract Guardian also supports re-evaluation on amendment so the contractual control surface stays aligned with the live risk profile maintained in Supplier Radar.

Title

 is the backbone for automating your third-party risk management program, allowing secure, direct retrieval of vendor profiles, risk assessments, control evaluations, and related compliance data.

 design with a predictable URL structure, and communicates entirely in 

The Export API requires you to first create a 

). The report allows you to build a custom API by defining the URL of the endpoint, which data it returns, and what labels to use.

To configure the report, you first pick a base object that the report returns. When you call the API endpoint for the report, it will return an array of JSON objects, each representing one of the base objects that you selected. Here are the base objects that are currently supported:

Vendor records include metadata such as name, website, ownership, risk level, and tags.

Example: A supplier record for “Acme Corp – Payments API” might differ from “Acme Corp – Cloud Hosting” if both are used by different teams.

An assessment is an analysis of a vendor's set of documents, questionnaires and contextual data against one or more control sets. Assessments are automatically populated, reviewed, and scored by Coverbase’s AI engine.

Example: Reviewing Acme Corp’s SOC 2 and CAIQ to determine whether they meet your encryption and access control expectations.

Assessments produced evaluations. Each one is the result of analysis of a single control. As such, there will be as many evaluations as there are controls that are assessed. Some evaluations that have weaknesses are considered issues. Evaluations come with context, evidence citations, and optional recommended mitigations.

Example: “Encryption control unmet — no evidence of data-at-rest encryption found in SOC 2.”

An atomic requirement used to evaluate a supplier’s security, legal, or operational posture. Each control has an expectation, guidance, weight, and supporting evidence references.

Example: “Vendor must encrypt customer data at rest with AES-256 or stronger.”

A collection of controls representing a full evaluation standard. Control sets may include sections (e.g., “Data Security” or “Business Continuity”) and are versioned for auditability.

Example: A custom control set derived from your internal security questionnaire.

 is the ingestion counterpart to the Export API, allowing secure, programmatic delivery of vendor, assessment, and service data into Coverbase from upstream systems of record.

The API uses a RESTful design with a predictable URL structure and communicates entirely in JSON. All interactions are authenticated with an API key and encrypted in transit.

The Import API requires you to first create an Import Report in the dashboard (

). The report defines the target base object, the field mapping between your incoming payload and Coverbase fields, and the POST endpoint used to submit records.

To configure the report, you first pick a base object that records will be imported into. When you POST to the endpoint, the request body contains a JSON array of records under the 

 key, each conforming to the mapped field schema for the selected base object. The following base objects are currently supported:

Imports create or update vendor records in the Coverbase vendor inventory. The payload supports core metadata (name, website, HQ location, description), lifecycle status, risk scoring fields (raw IRQ score, raw residual risk score), engagement context (business unit, enterprise flag, vendor category, dependent services), and scheduling fields (next assessment date, audit start, SOC 2 audit end, contract length).

 is the stable identifier from your source system and is used for upsert semantics: records with a matching 

 are updated in place rather than duplicated.

Example: Syncing the full list of active suppliers from your ERP nightly so that Coverbase's vendor inventory reflects procurement's source of truth without manual entry.

Imports create or update assessment records linked to a vendor. The payload supports assessment metadata (type, status, scope, assessor, assessment period), linkage to the target vendor, and historical scoring fields where available.

Imported assessments are treated as records of prior analysis rather than assessments Coverbase itself performed. They appear in the vendor's assessment history and can be referenced by Copilot during delta detection on subsequent reassessments.

Example: Migrating three years of completed SIG Lite and CAIQ assessments from a legacy GRC platform so that vendor history is preserved when customers cut over to Coverbase.

Imports create or update service records representing the specific third-party services a vendor provides. A single vendor can have multiple services, each with its own risk profile, data classification, and dependent internal systems.

The payload supports service metadata (name, description, data types processed, hosting model, criticality tier), the parent vendor reference, and dependency relationships to internal systems or downstream vendors.

Example: Loading a service catalog that distinguishes "Acme Corp, Payments API" from "Acme Corp, Cloud Hosting" so that assessments and monitoring events are scoped to the specific service consumed rather than the vendor as a whole.

Each Import Report defines a mapping from incoming field names in your payload to the corresponding Coverbase fields on the base object. The dashboard exposes all available target fields for the selected base object and surfaces which ones are required. Records submitted with unmapped fields are ignored; records missing a required field are rejected and returned in the response with an error reason.

Mappings are versioned with the report, so changes to upstream schemas can be handled by updating the mapping without changing the endpoint URL or client integration code.

All requests are POST to the report endpoint with a JSON body of the shape:

Batch size, partial-success semantics, and idempotency behavior are documented per base object in the endpoint detail view of the dashboard.

<p class="slate-p slate-indent-0" style="0px">The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.</p><p class="slate-p slate-indent-0" style="0px">It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >To start consuming the API:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Request API Credentials</strong> - Have a Coverbase admin provision an API key for your integration.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Secure Your Key </strong>- Store keys in a <strong class="slate-bold">vault service</strong> like AWS Secrets Manager or HashiCorp Vault. Never hardcode them into source code.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Test the Connection</strong> - Use the <code class="slate-code">/v1/utils/authtest</code> endpoint to confirm connectivity and authentication before building production logic.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Plan Data Flow</strong> - Decide where in your workflows the API will feed data:</div></li></ol><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Vendor master database updates</div></li><li class="slate-li " ><div style="position:relative">Risk scoring pipelines</div></li><li class="slate-li " ><div style="position:relative">Assessment tracking dashboards</div></li></ul><p class="slate-p " ></p>

The Base URL is a crucial element for making API calls, enabling you to clearly specify the root URL(s) for API requests. When making API calls, you combine the base URL with the specific endpoint path to form the complete request URL.

It supports multiple environments, including staging and production. Additionally, the base URL synchronizes with the API explorer, allowing you to seamlessly switch between environments like Sandbox and Production while trying out API calls.

<p class="slate-p slate-indent-0" style="0px">All requests must include a <strong class="slate-bold">Bearer token</strong> in the HTTP request header: <code class="slate-code">Authorization: Bearer &lt;api-key&gt;</code></p><p class="slate-p " >Example cURL Authentication</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -H &quot;Authorization: Bearer eyJhbGjoxNzzOi8vY2xl4ODk5dHRwczoRkuad3ZnZ2dnArFvNR6yoXBDjrSGnLVR1atpZCI6ImI6Imh0ZI9L-Wwx&quot; \
     -H &quot;Content-Type: application/json&quot; \
     https://api.coverbase.app/v1/utils/authtest</div></code></pre></div><p class="slate-p " >Example in Python</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Python</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">import requests

API_KEY = &quot;eyJhbGjoxNzzOi8vY2xl4ODk5dHRwczoRkuad3ZnZ2dnArFvNR6yoXBDjrSGnLVR1atpZCI6ImI6Imh0ZI9L-Wwx&quot;
BASE_URL = &quot;https://api.coverbase.app&quot;

headers = {
    &quot;Authorization&quot;: f&quot;Bearer {API_KEY}&quot;,
    &quot;Content-Type&quot;: &quot;application/json&quot;
}

response = requests.get(f&quot;{BASE_URL}/v1/utils/authtest&quot;, headers=headers)
print(response.json())</div></code></pre></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " >Your API keys grant significant access, so it’s crucial to keep them safe! Avoid sharing your secret API keys in public places like GitHub, client-side code, and similar locations.</p></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.6989 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">API requests without authentication will fail.</p></div></div><h2 class="slate-h2 " >Test Connection</h2><p class="slate-p " >Use this endpoint to verify:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Your API key is valid.</div></li><li class="slate-li " ><div style="position:relative">You can reach Coverbase’s servers.</div></li><li class="slate-li " ><div style="position:relative">Your firewall/proxy allows outbound HTTPS traffic.</div></li></ul><p class="slate-p " >Request</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -H &quot;Authorization: Bearer &lt;token&gt;&quot; \
     -H &quot;Content-Type: application/json&quot; \
     https://api.coverbase.app/v1/utils/authtest</div></code></pre></div><p class="slate-p " >Response</p><p class="slate-p " >If it succeeds, you&apos;ll receive a response with the <strong class="slate-bold">200 OK</strong> status code, along with the following body:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">{&quot;msg&quot;:&quot;Auth successful&quot;} </textarea><code class="language-plainText keep-markup drop-tokens">{&quot;msg&quot;:&quot;Auth successful&quot;}</code></pre></div><p class="slate-p " >Common Issues:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">401 Unauthorized:</strong> Invalid API key or missing Authorization header.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">403 Forbidden:</strong> API key is valid but lacks permissions for the resource.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Network timeouts:</strong> Check VPN/proxy/firewall rules.</div></li></ul><p class="slate-p " ></p>

If it succeeds, you'll receive a response with the 

 status code, along with the following body:

<p class="slate-p " ></p><h3 class="slate-h3 " >Export Report <strong class="slate-bold"> </strong><code class="slate-code">GET /v1/export/{report_name}</code></h3><p class="slate-p " >Retrieves the data for the specified report</p><p class="slate-p " ><strong class="slate-bold">Request Parameters</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">report_name</code> <em class="slate-italic">(string, required)</em> — The unique identifier of the report.</div></li></ul><p class="slate-p " >Optionally, <code class="slate-code">limit</code> and <code class="slate-code">offset</code> URL params can also be supplied to page through the data in the report.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"> <code class="slate-code">limit</code> (<em class="slate-italic">integer, optional) </em>— The maximum number of JSON objects to return in the data array.</div></li><li class="slate-li " ><div style="position:relative"> <code class="slate-code">offset</code> <em class="slate-italic">(integer, optional) </em>— The number of records to skip before starting to return data.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Example Request (cURL)</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -X GET &quot;https://api.coverbase.app/v1/export/vendor-custom-report?limit=10&amp;offset=20&quot; \
  -H &quot;Authorization: Bearer &lt;api-key&gt;&quot; \
  -H &quot;Content-Type: application/json&quot;</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Example Request (Python)</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Python</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">import os
import requests

API_KEY = os.getenv(&quot;COVERBASE_API_KEY&quot;, &quot;&lt;api-key&gt;&quot;)
BASE_URL = &quot;https://api.coverbase.app&quot;

report_name = &quot;vendor-custom-report&quot;

headers = {
    &quot;Authorization&quot;: f&quot;Bearer {API_KEY}&quot;,
    &quot;Content-Type&quot;: &quot;application/json&quot;,
}

resp = requests.get(f&quot;{BASE_URL}/v1/export/{report_name}?limit=10&amp;offset=20&quot;, headers=headers, timeout=30)
resp.raise_for_status()
report = resp.json()

print(&quot;Vendor Details:&quot;)
print(f&quot;ID: {report.get(&apos;id&apos;)}&quot;)
print(f&quot;Endpoint: {report.get(&apos;slug&apos;)}&quot;)
print(f&quot;Name: {report.get(&apos;report_name&apos;)}&quot;)
print(f&quot;Base Object: {report.get(&apos;base_object&apos;)}&quot;)</div><div class="slate-code_line">print(f&quot;Mapping: {report.get(&apos;mapping&apos;)}&quot;)</div><div class="slate-code_line">print(f&quot;Data: {report.get(&apos;data&apos;)}&quot;)</div><div class="slate-code_line">print(f&quot;Limit: {report.get(&apos;limit&apos;)}&quot;)</div><div class="slate-code_line">print(f&quot;Offset: {report.get(&apos;offset&apos;)}&quot;)</div><div class="slate-code_line">print(f&quot;Total Count: {report.get(&apos;total_count&apos;)}&quot;)</div><div class="slate-code_line"></div><div class="slate-code_line"></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Example Response</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;id&quot;: &quot;cbexprt_a13361e835664c26bb0551a860258f6d&quot;,
  &quot;slug&quot;: &quot;vendor-custom-report&quot;,
  &quot;report_name&quot;: &quot;Vendor Report&quot;,
  &quot;base_object&quot;: &quot;vendor&quot;,
  &quot;mapping&quot;: {
    &quot;id&quot;: &quot;Id&quot;,
    &quot;name&quot;: &quot;Name&quot;,
    &quot;status&quot;: &quot;Status&quot;,
    &quot;website&quot;: &quot;Website&quot;,
    &quot;products&quot;: &quot;Products&quot;,
    &quot;created_at&quot;: &quot;Created At&quot;,
    &quot;description&quot;: &quot;Description&quot;,
    &quot;hq_location&quot;: &quot;Hq Location&quot;
  },
  &quot;data&quot;: [
    {
      &quot;Id&quot;: &quot;cbvndr_0de9333fece3493eb3987b1a1af28119&quot;,
      &quot;Name&quot;: &quot;1Password&quot;,
      &quot;Status&quot;: &quot;Active&quot;,
      &quot;Website&quot;: &quot;1password.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1731132522,
      &quot;Description&quot;: &quot;1Password is a company that provides secure password management solutions for individuals and businesses.&quot;,
      &quot;Hq Location&quot;: &quot;Toronto, Ontario, Canada&quot;
    },
    {
      &quot;Id&quot;: &quot;cbvndr_38f2a1ebbe364746b38bdc8345f4f389&quot;,
      &quot;Name&quot;: &quot;2nd Watch&quot;,
      &quot;Status&quot;: &quot;Active&quot;,
      &quot;Website&quot;: &quot;ollion.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1722628989,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_af3c00a0ab5748a19647f68704270fbc&quot;,
      &quot;Name&quot;: &quot;2OS&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: null,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1722628989,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_6e79aabfeac1461c9ac2cf782749515c&quot;,
      &quot;Name&quot;: &quot;42stats&quot;,
      &quot;Status&quot;: &quot;Active&quot;,
      &quot;Website&quot;: &quot;42stats.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1724731912,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_e436ca623adc44c5af756d3a97eeb478&quot;,
      &quot;Name&quot;: &quot;Absolute Resolutions Corporation&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: &quot;absoluteresolutions.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1722628990,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_e448ba62882143f3ba0c140bb2e30162&quot;,
      &quot;Name&quot;: &quot;Acme Corp &quot;,
      &quot;Status&quot;: &quot;Active&quot;,
      &quot;Website&quot;: &quot;acmecorp.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1732292930,
      &quot;Description&quot;: &quot;EQT Corp is an independent natural gas production company with operations focused in the cores of the Marcellus and Utica shales in the Appalachian Basin, located in the Eastern United States. The firm focuses on executing combo-development projects for developing multiwell pads to meet supply needs, with a focus on maximizing operational efficiency, technology, and sustainability. Its main customers include marketers, utilities, and industrial operators in the Appalachian Basin. The company has one reportable segment and its revenue stems from three types of gas reserves: natural gas, natural gas liquids, and crude oil. All of the firm&apos;s operating revenue is generated in the U.S., with most revenue flowing from the Marcellus Shale field and through the sale of natural gas.&quot;,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_db9e89c838ff4235b74bed2aff26524b&quot;,
      &quot;Name&quot;: &quot;Acumen&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: &quot;acumenfiscalagent.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1739212795,
      &quot;Description&quot;: &quot; Ac umen  Fiscal  Agent  is  a  company  that  provides  financial  management  services  for  individuals  and  organizations  participating  in  self -directed  care  programs .&quot;,
      &quot;Hq Location&quot;: &quot;&quot;
    },
    {
      &quot;Id&quot;: &quot;cbvndr_4266c6bc4e7341f29497552d3bd90b02&quot;,
      &quot;Name&quot;: &quot;Adobe&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: &quot;adobe.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1716401869,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_c35f34f0586e468d8f8554bd152c843a&quot;,
      &quot;Name&quot;: &quot;Akur8&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: &quot;akur8.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1724735017,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    },
    {
      &quot;Id&quot;: &quot;cbvndr_2cf7c145861f400eac42f33110385a43&quot;,
      &quot;Name&quot;: &quot;Alloy&quot;,
      &quot;Status&quot;: &quot;Onboarding&quot;,
      &quot;Website&quot;: &quot;alloy.com&quot;,
      &quot;Products&quot;: [],
      &quot;Created At&quot;: 1715637758,
      &quot;Description&quot;: null,
      &quot;Hq Location&quot;: null
    }
  ],
  &quot;limit&quot;: 10,
  &quot;offset&quot;: 20,
  &quot;total_count&quot;: 157
}
}</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Response Fields:</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:233px;">Title</div><div style="width:initial;">Description</div></div><colgroup ><col style="width:233px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold"> Field                                      </strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold"> Description </strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " > id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique Coverbase export report ID. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >slug</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique string used in the API endpoint URL.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >report_name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Display name for the report.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >base_object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object that each record in <code class="slate-code">data</code> represents. Eg. &quot;assessment&quot; or “vendor”.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mapping</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mapping between Coverbase field names and field names exported in the JSON objects.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >data</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Array of JSON objects. Each one represents a <code class="slate-code">base_object</code>, and contains field names specified by the values in the <code class="slate-code">mapping</code> object.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >limit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The maximum length of the data array.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >offset</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The number of records to skip before the system starts returning records.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >total_count</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Total number of base objects in Coverbase.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ></p><div class="slate-code_line"></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >Need help? Email <a href="https://mailto:support@coverbase.com" target="_self">support@coverbase.com</a></p>

Retrieves the data for the specified report

 URL params can also be supplied to page through the data in the report.

Description

<p class="slate-p " ></p><h3 class="slate-h3 " >Import Report <strong class="slate-bold"> </strong><code class="slate-code">POST /v1/import/{report_name}</code></h3><p class="slate-p " >Submits a batch of records to the specified import report. Records are validated against the report&apos;s field mapping, upserted into the target base object using <code class="slate-code">external_id</code>, and returned with a per-record result summary.</p><p class="slate-p " ><strong class="slate-bold">Request Parameters</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">report_name</code> (string, required) — The unique identifier of the import report.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Request Body</strong></p><p class="slate-p " >The request body is a JSON object with a <code class="slate-code">data</code> key containing an array of records. Each record is an object whose keys are the mapped field names defined in the report, and whose values are the incoming field values.</p><p class="slate-p " ><code class="slate-code">data</code> (array of objects, required) — Records to import. Each record must include all fields marked as Required in the report&apos;s mapping.</p><p class="slate-p " ><strong class="slate-bold">Example Request (cURL)</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">CURL</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl -X POST &quot;https://api.coverbase.app/v1/import/vendor-custom-import&quot; \
  -H &quot;Authorization: Bearer &lt;api-key&gt;&quot; \
  -H &quot;Content-Type: application/json&quot; \
  -d &apos;{
    &quot;data&quot;: [
      {
        &quot;Name&quot;: &quot;Acme Corporation&quot;,
        &quot;External Id&quot;: &quot;vendor-123&quot;,
        &quot;Website&quot;: &quot;https://acmecorp.com&quot;,
        &quot;Status&quot;: &quot;active&quot;,
        &quot;Hq Location&quot;: &quot;San Francisco, CA&quot;,
        &quot;Raw Irq Score&quot;: &quot;85&quot;
      },
      {
        &quot;Name&quot;: &quot;Beta Services&quot;,
        &quot;External Id&quot;: &quot;vendor-456&quot;,
        &quot;Website&quot;: &quot;https://betaservices.io&quot;,
        &quot;Status&quot;: &quot;onboarding&quot;
      }
    ]
  }&apos;</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Example Request (Python)</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Python</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">import os
import requests

API_KEY = os.getenv(&quot;COVERBASE_API_KEY&quot;, &quot;&lt;api-key&gt;&quot;)
BASE_URL = &quot;https://api.coverbase.app&quot;

report_name = &quot;vendor-custom-import&quot;

headers = {
    &quot;Authorization&quot;: f&quot;Bearer {API_KEY}&quot;,
    &quot;Content-Type&quot;: &quot;application/json&quot;,
}

payload = {
    &quot;data&quot;: [
        {
            &quot;Name&quot;: &quot;Acme Corporation&quot;,
            &quot;External Id&quot;: &quot;vendor-123&quot;,
            &quot;Website&quot;: &quot;https://acmecorp.com&quot;,
            &quot;Status&quot;: &quot;active&quot;,
            &quot;Hq Location&quot;: &quot;San Francisco, CA&quot;,
            &quot;Raw Irq Score&quot;: &quot;85&quot;,
        },
        {
            &quot;Name&quot;: &quot;Beta Services&quot;,
            &quot;External Id&quot;: &quot;vendor-456&quot;,
            &quot;Website&quot;: &quot;https://betaservices.io&quot;,
            &quot;Status&quot;: &quot;onboarding&quot;,
        },
    ]
}

resp = requests.post(
    f&quot;{BASE_URL}/v1/import/{report_name}&quot;,
    headers=headers,
    json=payload,
    timeout=30,
)
resp.raise_for_status()
result = resp.json()

print(&quot;Import Result:&quot;)
print(f&quot;ID: {result.get(&apos;id&apos;)}&quot;)
print(f&quot;Endpoint: {result.get(&apos;slug&apos;)}&quot;)
print(f&quot;Name: {result.get(&apos;report_name&apos;)}&quot;)
print(f&quot;Base Object: {result.get(&apos;base_object&apos;)}&quot;)
print(f&quot;Mapping: {result.get(&apos;mapping&apos;)}&quot;)
print(f&quot;Received: {result.get(&apos;received_count&apos;)}&quot;)
print(f&quot;Created: {result.get(&apos;created_count&apos;)}&quot;)
print(f&quot;Updated: {result.get(&apos;updated_count&apos;)}&quot;)
print(f&quot;Failed: {result.get(&apos;failed_count&apos;)}&quot;)
print(f&quot;Results: {result.get(&apos;results&apos;)}&quot;)
print(f&quot;Errors: {result.get(&apos;errors&apos;)}&quot;)</div><div class="slate-code_line"></div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Example Response</strong></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
  &quot;id&quot;: &quot;cbimprt_7b2c918fa4e14e6c9a3d7b21d4f8a0c2&quot;,
  &quot;slug&quot;: &quot;vendor-custom-import&quot;,
  &quot;report_name&quot;: &quot;Vendor Import&quot;,
  &quot;base_object&quot;: &quot;vendor&quot;,
  &quot;mapping&quot;: {
    &quot;name&quot;: &quot;Name&quot;,
    &quot;external_id&quot;: &quot;External Id&quot;,
    &quot;website&quot;: &quot;Website&quot;,
    &quot;status&quot;: &quot;Status&quot;,
    &quot;hq_location&quot;: &quot;Hq Location&quot;,
    &quot;raw_irq_score&quot;: &quot;Raw Irq Score&quot;
  },
  &quot;received_count&quot;: 2,
  &quot;created_count&quot;: 1,
  &quot;updated_count&quot;: 1,
  &quot;failed_count&quot;: 0,
  &quot;results&quot;: [
    {
      &quot;external_id&quot;: &quot;vendor-123&quot;,
      &quot;coverbase_id&quot;: &quot;cbvndr_e448ba62882143f3ba0c140bb2e30162&quot;,
      &quot;action&quot;: &quot;updated&quot;,
      &quot;status&quot;: &quot;success&quot;
    },
    {
      &quot;external_id&quot;: &quot;vendor-456&quot;,
      &quot;coverbase_id&quot;: &quot;cbvndr_9f4a1c0d7b2e4e9f8c1d2b3a4e5f6071&quot;,
      &quot;action&quot;: &quot;created&quot;,
      &quot;status&quot;: &quot;success&quot;
    }
  ],
  &quot;errors&quot;: [],
  &quot;received_at&quot;: 1745481600
}</div></code></pre></div><p class="slate-p " ><strong class="slate-bold">Response Fields:</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100%;">Title</div><div style="width:100%;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Field</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique Coverbase import report ID.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >slug</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unique string used in the API endpoint URL.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >report_name</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Display name for the report.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >base_object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Object that each record in data represents. Eg. &quot;vendor&quot;, &quot;assessment&quot;, or &quot;service&quot;.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >mapping</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Mapping between Coverbase field names and field names accepted in the incoming JSON objects.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >received_count</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Total number of records received in the request body.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >created_count</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number of records that resulted in a new base object being created.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >updated_count</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number of records that matched an existing base object on external_id and were updated in place.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >failed_count</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number of records that were rejected due to validation or mapping errors.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >results</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Array of per-record result objects for successfully processed records. Each contains external_id, coverbase_id, action (&quot;created&quot; or &quot;updated&quot;), and status.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >errors</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Array of per-record error objects for rejected records. Each contains the record index, external_id (if available), error_code, and a human-readable message.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >received_at</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Unix timestamp indicating when the import batch was received.</p></td></div></tr></tbody></table></div></div><p class="slate-p " ><strong class="slate-bold">Error Codes:</strong></p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100%;">Title</div><div style="width:100%;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Code</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">Description</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >missing_required_field</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A required field (e.g., name or external_id) was absent from the record.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >invalid_field_value</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A field value failed type or format validation (e.g., malformed date, non-numeric score).</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >unmapped_field</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A field in the record is not defined in the report&apos;s mapping and was ignored. Informational only; does not fail the record.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >unknown_base_object</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The report&apos;s configured base object is no longer valid.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >duplicate_external_id</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The same external_id appears more than once in a single request batch.</p></td></div></tr></tbody></table></div></div><p class="slate-p " >Partial success is supported: records that pass validation are imported even if other records in the same batch fail. The HTTP response code is 200 when at least one record succeeds, and 400 when all records fail validation.</p><div class="slate-code_line"></div><div class="slate-code_line"></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " >Need help? Email <a href="https://mailto:support@coverbase.com" target="_self">support@coverbase.com</a></p><p class="slate-p " ></p>

Submits a batch of records to the specified import report. Records are validated against the report's field mapping, upserted into the target base object using 

, and returned with a per-record result summary.

The request body is a JSON object with a 

 key containing an array of records. Each record is an object whose keys are the mapped field names defined in the report, and whose values are the incoming field values.

 (array of objects, required) — Records to import. Each record must include all fields marked as Required in the report's mapping.

Name

Partial success is supported: records that pass validation are imported even if other records in the same batch fail. The HTTP response code is 200 when at least one record succeeds, and 400 when all records fail validation.

Sections