Developers

Conphora API reference

Read the compliance status, Risk Score and customer pack of your products from your own systems, push new products into Conphora, and pull your whole catalogue as a live feed. The API is meant to be called from a server.

Create an API key
Base URL
https://documents.conphora.com
Current version
/api/v1 · meta.apiVersion: "2026-09-10"

The read API (GET /api/v1/products, GET /api/v1/fields) and the product feed are available on every plan. POST /api/v1/intake needs the self-service plan and a read_write key.

Start here

Authentication

Every API request carries an API key. A key belongs to one organisation and can only read that organisation's compliance profiles.

Create a key

  1. On the platform, open Settings → API Keys and create a key. Give it a name for your own reference.
  2. Choose the scope: leave "Allow this key to push products into the Inbox" unticked for a read-only key, tick it for a read_write key.
  3. If your organisation has two or more compliance profiles, you can bind the key to one of them.
  4. Copy the key. It starts with cfa_live_ and is shown once only: Conphora cannot show it again. If you lose it, revoke it and create a new one.

The key list shows each key's first characters, name, scope, its profile binding, when it was created and when it was last used. Revoking a key takes effect immediately; the key then gets 401 revoked_api_key. You can rename a key, but not change its scope or binding, create a new key instead.

Send the key

Send the key in the x-api-key header. Authorization: Bearer <key> is accepted too; when both are sent, x-api-key wins.

Example: invented dataHTTP
x-api-key: cfa_live_…
# or
Authorization: Bearer cfa_live_…

Use the key on your server only, never in storefront or browser JavaScript. Browsers calling the API directly are not supported.

Scopes

Scopes
Key scopeMeaning
readGET /api/v1/products and GET /api/v1/fields. The default.
read_writeEverything read can call, plus POST /api/v1/intake.

The scope is fixed when the key is created.

Profile binding

  • A key bound to a profile may only name that profile. Any other profileId gets 403 profile_not_allowed.
  • An unbound key may name any profile in its organisation. A profile that does not exist, or belongs to another organisation, gets 404 profile_not_found.

Where to find your profile id

Every endpoint needs a profileId: the id of a compliance profile on the platform. Settings → API Keys shows an example request that already contains it. GET /api/v1/fields returns the profile's id and name, so you can check you have the right one.

GET/api/v1/products

Look up products

Look up 1 to 100 products by your own identifier, by name or by barcode, and get their compliance status, Risk Score, next action and customer pack. There is no endpoint that lists a whole catalogue; use the product feed for that.

Key scope: readPlan: every plan

Query parameters

ParameterTypeRequiredDefaultMeaning
profileIdstringyesThe compliance profile to look in. It must belong to the key's organisation, and match the key's binding if the key is bound.
valuesstring (comma-separated or repeated)yesThe values to look up. values=A,B,C and values=A&values=B both work; use the repeated form when a value contains a comma. Values are trimmed, blanks are dropped and exact duplicates are dropped and counted. At most 100 after duplicates are removed.
valuestringaliasAccepted as an alias of values and merged with it.
fieldidentifier | name | gtinnoidentifierWhat the values are: identifier = your own product identifier (the column your import mapped as the identifier, such as "SKU"), name = the product name, gtin = an EAN / UPC / GTIN barcode. Case-insensitive. No other names are accepted.
includeArchivedtruenofalseInclude archived products. Without it, archived matches are left out and a not_found result reports archivedMatchCount when archived products matched.

How matching works

  • identifier: an exact match first, then tolerant variants: leading zeros of all-digit values are ignored ("0012345" finds "12345"), then punctuation, then case. All-digit values longer than 15 digits are refused as value_precision_unsupported. A value can be at most 512 characters.
  • gtin: the barcode is normalised to the 14-digit GS1 form and matched exactly. 8, 12, 13 and 14 digits and separators are fine; anything else is not_a_gtin.
  • name: the exact name first, then a search that ignores case and punctuation.
  • When more than one product matches, the result is ambiguous with the candidates. The API never guesses: ask again with a candidate's identifier.
  • With field=identifier, a value that is not a product yet but is waiting in the Inbox comes back as staged.

Response

The response has results (one per distinct value, in request order), summary and meta. A value that is not found, ambiguous or invalid is not an HTTP error: it comes back inside the 200 as its own result.

Results by status

statusFieldMeaning
foundvalue, matchedVia, productExactly one product matched.
not_foundvalue, archivedMatchCount (only when > 0)No match.
stagedvalue, inbox { status: pending | dismissed, receivedAt }Waiting in the Inbox, not yet tracked, so there is no compliance state yet.
ambiguousvalue, matches [{ id, identifier, name }]Several products matched.
ambiguous_truncatedvalueThe search hit its limit of candidates. Narrow the value or use identifier. Cannot happen with field=gtin.
invalid_valuevalue, reason: empty_value | value_too_long | value_precision_unsupported | not_a_gtinThe value cannot be looked up.

matchedVia tells you how a found product matched: identifier_exact, identifier_numeric_zerostrip, identifier_numeric_roundtrip, identifier_alnum, identifier_normalized, name_exact, name_normalized, gtin_exact, gtin_canonical.

summary counts the results: requested, found, notFound, staged, ambiguous, invalid, duplicatesDropped. ambiguous includes ambiguous_truncated; duplicatesDropped appears only when values were dropped.

meta holds resolvedField (the field used), identifierField (what your import called the identifier column, for information) and apiVersion.

The product object

Every key is always present, in this order. Your imported spreadsheet columns are never returned by the API.

FieldTypeMeaning
idstringConphora's stable product id. Not a lookup value.
profileIdstringThe compliance profile.
identifierstringYour product identifier.
identifierFieldstring | nullYour import's name for the identifier column.
gtinstring | nullThe barcode as 14 digits, zero-padded; null when the import had no valid barcode.
namestringThe product name.
imageUrlstring | nullThe image URL from your import.
hsCodestring | nullThe HS / commodity code.
archivedbooleanTrue for an archived product.
status.classificationin_progress | awaiting_clarification | completed | failed | nullWhere the classification stands; null when it has not started.
status.compliancenot_checked | compliant | requires_complianceThe compliance state. Never null: not_checked when the product has never been evaluated.
compliance.lastCheckedAtnumber (ms epoch) | nullWhen the product was last evaluated.
compliance.summary.matchedCountnumberHow many requirements apply.
compliance.summary.fulfilledCountnumberHow many of those are fulfilled.
compliance.progress{ compliance, attributes, documents }: { filled, total }Filled / total pairs for requirements, product data and documents; {0, 0} when there are none.
compliance.matchedRegulations[]{ id, shortName, fullTitle | null, eurLexUrl | null }The regulations that apply.
compliance.missingRequirements[]{ key, kind, regulation, requirementId, domain | null, label, deferred }The open requirements. kind is doc, attr, symbol or checkpoint. deferred = marked "I don't have this data yet"; it still counts as missing.
riskScoreinteger 0–100 | nullThe Conphora Risk Score: a priority, not a verdict. Null until the product is scored.
riskBandlow | watch | high | critical | nullThe band of the score. Null when there is no score.
nextActionobject | nullThe one next thing to do. Null when there is no score or nothing to do.
nextAction.kindstring (see the list below)What to do.
nextAction.whoyou | supplierWhose turn it is.
nextAction.hrefstring (relative platform path)A relative path on the platform that opens the action. Open it on the platform's host.
nextAction.afternumberThe Risk Score once this action is done.
customerPackobject | nullThe customer pack with all ten items and their status (your working view, the same as on the product page). Filled on the self-service plan; null on the free check, and null when the profile has no company data yet.
customerPack.readyinteger 0–10How many of the ten items are ready.
customerPack.total10Always 10.
customerPack.itemsobject: item id → ready | missing | waiting | not-neededEach item's status, in pack order. not-needed = no part of the item applies to the product.
customerPack.urlstring | nullThe full link to the product's public customer-pack page: the product's own standing link (the same one the export and the feed carry). null when there is none, and on the free check.
customerPack.pathstring | nullThe same link as a path, /p/<token>, on the documents host.
createdAtnumber (ms epoch)When the product was created in Conphora.
updatedAtnumber (ms epoch)When the product last changed.

Risk Score, band and next action

riskScore, riskBand and nextAction are the same on every plan. The score says which products to fix first; it never calls a product compliant or non-compliant. A known non-compliance puts the product in critical whatever the score.

Risk bands
riskBandScoreMeaning
low0-24Monitored, nothing to do
watch25-49Something is coming
high50-74Fix this month
critical75-100Act now

nextAction.kind is one of a fixed set: clearNonCompliance, reEvaluate, uploadDocument, confirmRequirement, fillProductData, askSupplier, issueDeclaration, runProcedure, registerProduct, assembleTechnicalFile, renewDocument, reconfirmRuleChange, meetKeyDate, submitReport, chaseSupplier, reviewSupplierAnswer.

How the Risk Score works

Customer pack items

The keys of customerPack.items, in pack order. Each status is ready, missing, waiting or not-needed. identity, contact, declaration, standards-tests, safety-information, instructions, substances, packaging-epr, technical-file, recall-contact.

The API keeps all ten statuses. The public pack page your customer opens shows your customer two groups: identity, contact, declaration, safety-information and instructions from the start, counted as "n of 5 ready to list"; standards-tests, substances, packaging-epr and recall-contact on request, each with a button that asks you; technical-file is not on the page.

Example request

Example: invented datacurl
curl "https://documents.conphora.com/api/v1/products?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c&field=identifier&values=NB-1042,NB-2210,NB-9999" \
  -H "x-api-key: cfa_live_…"

Example response

Example: invented dataJSON
{
  "results": [
    {
      "value": "NB-1042",
      "status": "found",
      "matchedVia": "identifier_exact",
      "product": {
        "id": "k57bq2x9w3m8r1t6v4c0n5p7ds",
        "profileId": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
        "identifier": "NB-1042",
        "identifierField": "SKU",
        "gtin": "05790000123452",
        "name": "Birch stacking rings, 7 pieces",
        "imageUrl": null,
        "hsCode": "9503.00",
        "archived": false,
        "status": {
          "classification": "completed",
          "compliance": "requires_compliance"
        },
        "compliance": {
          "lastCheckedAt": 1793260800000,
          "summary": {
            "matchedCount": 14,
            "fulfilledCount": 9
          },
          "progress": {
            "compliance": {
              "filled": 9,
              "total": 14
            },
            "attributes": {
              "filled": 6,
              "total": 8
            },
            "documents": {
              "filled": 3,
              "total": 5
            }
          },
          "matchedRegulations": [
            {
              "id": "toy-safety",
              "shortName": "TSR",
              "fullTitle": "Toy Safety Regulation",
              "eurLexUrl": null
            },
            {
              "id": "gpsr",
              "shortName": "GPSR",
              "fullTitle": "General Product Safety Regulation",
              "eurLexUrl": null
            }
          ],
          "missingRequirements": [
            {
              "key": "doc:TSR:eu-declaration-of-conformity",
              "kind": "doc",
              "regulation": "TSR",
              "requirementId": "eu-declaration-of-conformity",
              "domain": "documentation",
              "label": "EU declaration of conformity",
              "deferred": false
            }
          ]
        },
        "riskScore": 58,
        "riskBand": "high",
        "nextAction": {
          "kind": "issueDeclaration",
          "who": "you",
          "href": "/nordbirk/products/k57bq2x9w3m8r1t6v4c0n5p7ds?step=declaration",
          "after": 41
        },
        "customerPack": {
          "ready": 6,
          "total": 10,
          "items": {
            "identity": "ready",
            "contact": "ready",
            "declaration": "missing",
            "standards-tests": "ready",
            "safety-information": "ready",
            "instructions": "waiting",
            "substances": "ready",
            "packaging-epr": "missing",
            "technical-file": "ready",
            "recall-contact": "missing"
          },
          "url": null,
          "path": null
        },
        "createdAt": 1790582400000,
        "updatedAt": 1793260800000
      }
    },
    {
      "value": "NB-2210",
      "status": "staged",
      "inbox": {
        "status": "pending",
        "receivedAt": 1793174400000
      }
    },
    {
      "value": "NB-9999",
      "status": "not_found"
    }
  ],
  "summary": {
    "requested": 3,
    "found": 1,
    "notFound": 1,
    "staged": 1,
    "ambiguous": 0,
    "invalid": 0
  },
  "meta": {
    "resolvedField": "identifier",
    "identifierField": "SKU",
    "apiVersion": "2026-09-10"
  }
}

Errors

400 missing_parameter, 400 too_many_values, 400 unknown_field, 400 invalid_profile_id, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 profile_not_allowed, 404 profile_not_found, 413 response_too_large, 429 rate_limited — Errors

GET/api/v1/fields

Discover fields

Shows which `field` values the lookup accepts and what the profile's import calls its identifier column. Any key scope; same profile rules as above.

Key scope: readPlan: every plan

Query parameters

ParameterTypeRequiredMeaning
profileIdstringyesThe compliance profile.

Response

FieldTypeMeaning
profile.idstringThe profile id.
profile.namestringThe profile name.
identifierFieldstring | nullWhat the newest import calls the identifier column.
supportedFieldsstring[]Always ["identifier", "name", "gtin"].
meta.apiVersionstringThe API version.

Example request

Example: invented datacurl
curl "https://documents.conphora.com/api/v1/fields?profileId=jd7f3k2m9q8x4w1v6t5r0n3b2c" \
  -H "x-api-key: cfa_live_…"

Example response

Example: invented dataJSON
{
  "profile": {
    "id": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
    "name": "Nordbirk ApS"
  },
  "identifierField": "SKU",
  "supportedFields": [
    "identifier",
    "name",
    "gtin"
  ],
  "meta": {
    "apiVersion": "2026-09-10"
  }
}

Errors

400 missing_parameter, 400 invalid_profile_id, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 profile_not_allowed, 404 profile_not_found, 429 rate_limited — Errors

POST/api/v1/intake

Push products

Push up to 100 products per request into a profile's Inbox. New identifiers wait in the Inbox until someone on your team moves them to tracking; a product whose identifier matches an existing product updates that product in place. The push itself is not billed, and sending the same product again changes nothing.

Key scope: read_writePlan: self-service plan

Needs a key with the read_write scope (otherwise 403 insufficient_scope) and the self-service plan (otherwise 403 membership_required). The body is JSON, at most 1 MB.

Request body

FieldTypeRequiredMeaning
profileIdstringyesThe target compliance profile.
productsarray (1–100)yesThe products. A later duplicate of a uniqueId is dropped (the first one wins) and counted.
products[].uniqueIdstring | numberyesYour product identifier, at most 512 characters after trimming.
products[].namestringyesThe product name (at most 10,000 characters).
products[].descriptionstringyesThe product description. Conphora's classification needs it.
products[].gtinstring | numbernoThe barcode. When present it must be a valid GTIN, or the row is rejected with not_a_gtin.
products[].imageUrlstringnoAn image URL.
products[].attributesobject of string | number | boolean | nullnoAny other columns, as a flat object. At most 300 keys of at most 200 characters; long strings are cut to 10,000 characters; nested values are rejected. A key named like a top-level field is overwritten by the top-level value.
products[].hintsobject: category → attribute keysnoTells the classification which attributes describe what. Every key must exist in attributes and may appear in one category only.

Hint categories: productDescription, material, productCategory, packaging, supplierInfo, other.

A profile's Inbox holds at most 50,000 waiting rows; a push past that gets 429 intake_full.

Response

results are in request order, one per product: uniqueId, status, and intakeId, productId or errors where they apply.

Results by status

statusMeaning
stagedNew: now waiting in the Inbox (intakeId).
refreshedWas already waiting; its content was updated.
resurfacedHad been dismissed from the Inbox and came back as pending because its content changed.
unchangedAlready known, and nothing changed.
updatedMatched an active product, which was updated (productId).
updated_idleMatched an archived product, which was updated in place and stays archived.
invalidThe row was rejected: errors lists { field, reason }.

Reasons for invalid: required, invalid_type, too_long, not_a_gtin, too_many_attributes, unknown_category, reserved_key, unknown_attribute, assigned_twice.

summary counts the results: received, staged, refreshed, unchanged, updated, updatedIdle, archivedSkipped, invalid, duplicatesDropped. received counts products after duplicates were dropped; refreshed includes resurfaced; archivedSkipped is always 0 and kept for older clients.

If a request fails part-way with 500 intake_failed, the products before index completed were saved and results lists them; send the rest again.

Example request

Example: invented datacurl
curl -X POST "https://documents.conphora.com/api/v1/intake" \
  -H "x-api-key: cfa_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "profileId": "jd7f3k2m9q8x4w1v6t5r0n3b2c",
  "products": [
    {
      "uniqueId": "NB-3001",
      "name": "Oak pull-along duck",
      "description": "Wooden pull toy for children from 12 months, water-based paint.",
      "gtin": "5790000123469",
      "attributes": {
        "Material": "Oak, water-based paint",
        "Age": "12m+"
      },
      "hints": {
        "material": [
          "Material"
        ]
      }
    },
    {
      "uniqueId": "NB-3002",
      "name": "Felt play mat"
    }
  ]
}'

Example response

Example: invented dataJSON
{
  "results": [
    {
      "uniqueId": "NB-3001",
      "status": "staged",
      "intakeId": "m12x7c4v9b2n8q5w3e6r1t0y4u"
    },
    {
      "uniqueId": "NB-3002",
      "status": "invalid",
      "errors": [
        {
          "field": "description",
          "reason": "required"
        }
      ]
    }
  ],
  "summary": {
    "received": 2,
    "staged": 1,
    "refreshed": 0,
    "unchanged": 0,
    "updated": 0,
    "updatedIdle": 0,
    "archivedSkipped": 0,
    "invalid": 1
  },
  "meta": {
    "apiVersion": "2026-09-10"
  }
}

Errors

400 missing_parameter, 400 invalid_profile_id, 400 invalid_json, 400 invalid_payload, 400 too_many_products, 401 missing_api_key, 401 invalid_api_key, 401 revoked_api_key, 403 insufficient_scope, 403 profile_not_allowed, 403 membership_required, 404 profile_not_found, 413 payload_too_large, 429 rate_limited, 429 intake_full, 500 intake_failed, 503 rate_limiter_unavailable — Errors

GET/feed/{token}

Product feed

A product feed is a fixed URL that always serves the latest data of one compliance profile's active products, as JSON, CSV or Excel. It needs no API key: the token in the URL is the credential, so anyone who has the URL can read the feed until you revoke it.

Create and revoke a feed link

  1. On the platform, open Tables, choose "Feed" in the toolbar and create a link. The link takes the columns visible in the table at that moment; you can change its columns and give it a label later.
  2. Each link has copy buttons for CSV, XLSX and JSON.
  3. Revoking a link takes effect immediately: the next request gets 404.

Feed links are available on every plan. The two customer-pack columns are filled on the self-service plan only.

Query parameters

ParameterMeaning
formatThe output format: json (the default), csv or xlsx.
sharedKeep only the products that have an open customer-pack share link with this label (your customer's name, case-insensitive), and point each row's "Customer pack URL" at that share instead of the product's standing link. This gives one customer a catalogue-level pack. Empty on the free check, which has no share links.

Formats

formatMeaning
jsonAn array of objects, one key per column name. Structured columns are arrays and objects, dates are ISO 8601, missing values are null.
csvUTF-8 with a header row of column names, comma-separated. Cells with several values are joined with line breaks.
xlsxOne sheet with the same cells as the CSV.

Columns

A link serves the columns chosen for it, in this order: first your own imported columns under their own names (identifier, name, then the rest), then Conphora's columns. Unlike the API, the feed does include your imported data:

ColumnMeaning
EAN / GTINThe 14-digit barcode.
Commodity CodeThe HS code.
Matched RegulationsThe short names of the regulations that apply.
MarketsThe markets, with country code and name.
EN StandardsThe recommended standards (shown on the platform as "Recommended Standards"; the feed keeps this name).
Tested forWhat your documents show the product was tested for.
AttributesThe product data, label, value and unit.
Attributes on ProductThe attributes that go on the product.
Attributes on PackagingThe attributes that go on the packaging.
Attributes in DocumentationThe attributes that go in the documentation.
Attributes in Online ListingThe attributes that go in the online listing.
Document LinksOne entry per document: title, type, compliance areas and a link to the document.
Customer pack"6 of 10 ready" and each of the ten items' status (the feed keeps all ten; the pack page shows five from the start and four on request) (in JSON: { ready, total, items }). Empty, or null in JSON, on the free check.
Customer pack URLThe link to the product's customer-pack page: the product's own standing link, or the shared customer's share when you filter. Empty on the free check.
CreatedWhen the product was created.
UpdatedWhen the product last changed.

The feed has no compliance-status, Risk Score or next-action column; those are in the API. The feed has no version number: its column names are its contract, and your imported column names follow your imports.

Example request

Example: invented datacurl
curl "https://documents.conphora.com/feed/<your-feed-token>?format=json"

Example response

Example: invented dataJSON
[
  {
    "SKU": "NB-1042",
    "Product name": "Birch stacking rings, 7 pieces",
    "Colour": "Natural",
    "EAN / GTIN": "05790000123452",
    "Commodity Code": "9503.00",
    "Matched Regulations": [
      "TSR",
      "GPSR"
    ],
    "Markets": [
      {
        "countryCode": "DK",
        "name": "Denmark"
      },
      {
        "countryCode": "SE",
        "name": "Sweden"
      }
    ],
    "Customer pack": {
      "ready": 6,
      "total": 10,
      "items": {
        "identity": "ready",
        "contact": "ready",
        "declaration": "missing",
        "standards-tests": "ready",
        "safety-information": "ready",
        "instructions": "waiting",
        "substances": "ready",
        "packaging-epr": "missing",
        "technical-file": "ready",
        "recall-contact": "missing"
      }
    },
    "Customer pack URL": null,
    "Created": "2026-09-29T08:00:00.000Z",
    "Updated": "2026-10-29T08:00:00.000Z"
  }
]

Feed errors are plain text, not JSON: 404 when the link is invalid or revoked, 413 when the export would be too large (CSV is the most compact format).

Rate limits

Reads and writes have separate limits, each counted per API key and per organisation (all keys together). A request must pass both. The figures are today's values, set to stop runaway scripts, not to throttle normal use.

RequestsCounted perRateBurst
GET /api/v1/products, GET /api/v1/fieldsAPI key600 / minute120
GET /api/v1/products, GET /api/v1/fieldsorganisation3,000 / minute500
POST /api/v1/intakeAPI key120 / minute30
POST /api/v1/intakeorganisation600 / minute100

Over the limit, the API answers 429 with the error rate_limited, a retryAfterMs field and a Retry-After header in seconds (at least 1). Wait that long before you retry.

Example: invented dataHTTP
HTTP/1.1 429 Too Many Requests
Retry-After: 2

{
  "error": "rate_limited",
  "message": "Too many requests. Slow down and retry.",
  "retryAfterMs": 1800
}

Errors

Every error from an `/api/v1` endpoint is JSON of the shape `{ "error": "<code>", "message": "<text>" }`, sometimes with extra fields, sent with the HTTP status. Branch on `error`, never on `message`. A wrong method or an unknown path is not one of these endpoints and does not answer in this shape.

StatuserrorWhenExtra fieldsEndpoints
400missing_parameterNo profileId, no values, or no products / an empty array.all
400too_many_valuesMore than 100 distinct values.maxValuesGET /api/v1/products
400unknown_fieldfield is not identifier, name or gtin.supportedFieldsGET /api/v1/products
400invalid_profile_idprofileId is not a well-formed id.all
400invalid_jsonThe body is not JSON.POST /api/v1/intake
400invalid_payloadThe body is not an object, or products is not an array.POST /api/v1/intake
400too_many_productsMore than 100 products.maxProductsPOST /api/v1/intake
401missing_api_keyNo key was sent.all
401invalid_api_keyThe key is unknown.all
401revoked_api_keyThe key was revoked.all
403insufficient_scopeA read key called the intake.POST /api/v1/intake
403profile_not_allowedThe key is bound to a different profile.all
403membership_requiredThe organisation has no active self-service plan.POST /api/v1/intake
404profile_not_foundThe profile does not exist or belongs to another organisation.all
413response_too_largeThe result would be larger than about 18 MB. Ask for fewer values.GET /api/v1/products
413payload_too_largeThe body is larger than 1 MB.maxBodyBytesPOST /api/v1/intake
429rate_limitedA rate limit was reached.retryAfterMs + Retry-After headerall
429intake_fullThe profile's Inbox would pass 50,000 waiting rows.POST /api/v1/intake
500intake_failedThe request failed part-way; the products before index completed were saved.completed, resultsPOST /api/v1/intake
503rate_limiter_unavailableWrites are briefly unavailable. Retry after the Retry-After header.Retry-After headerPOST /api/v1/intake

Versioning

  • The version is in the path (/api/v1) and in every response body as meta.apiVersion.
  • Fields may be added at any time. Build clients that ignore fields they do not know.
  • A breaking change changes the version.

meta.apiVersion: "2026-09-10"

Ready to connect?

Create a key in Settings → API Keys on the platform and make your first lookup.

Create an API key