Developers

API reference

Product authenticity verification. Consumer verification is public; the manufacturer API uses scoped API keys (X-Api-Key). All errors share one envelope; 429 and 503 include Retry-After.

CredCheck API 1.0.0 · 52 endpoints · generated from the OpenAPI description

Production (cc_live_ keys)

https://api.credcheck.app

Sandbox (cc_test_ keys)

https://api.sandbox.credcheck.app

openapi.json Postman collection

Verification

Verify a product code(link to this endpoint)

No API key needed

POST/v1/verify

Checks a code (or a full QR URL). Always answers 200 with an outcome for well-formed requests — an unknown code is suspected_counterfeit, never an error. Safe to retry. unable_to_verify and service errors never imply product risk. Public callers can report channel as web, mobile_app or api; any other value is recorded as web (SMS, USSD and WhatsApp are reserved for CredCheck gateways).

Request body (application/json, required)

Name	Type	Required	Rules
`code`	string	Required	3–200 characters
`channel`	string	Optional	One of: "mobile_app", "web", "ussd", "sms", "whatsapp", "api", "retail_sdk" Default "web"
`signature`	string	Optional	Up to 64 characters
`deviceId`	string	Optional	Up to 200 characters
`location`	object	Optional	No other fields allowed
`location.country`	string	Optional	2–2 characters
`location.consent`	boolean	Optional	—
`captchaToken`	string	Optional	—
`sellerCode`	string	Optional	Up to 40 characters

Responses

200 Verification result · application/json · VerifyResult

Name	Type	Required	Rules
`outcome`	string	Required	One of: "verified", "unable_to_verify", "suspected_counterfeit", "recalled", "expired"
`checkedAt`	string (date-time)	Required	—
`referenceId`	string	Required	—
`product`	object \| null	Optional	—
`product.name`	string	Optional	—
`product.brand`	string	Optional	—
`product.imageUrl`	string \| null	Optional	—
`product.batchNumber`	string	Optional	—
`product.expiryDate`	string \| null	Optional	—
`product.manufacturerVerified`	boolean	Optional	—
`trust`	object	Required	—
`trust.scanCount`	integer	Optional	—
`trust.firstScan`	boolean	Optional	—
`trust.warnings`	array of object	Optional	—
`trust.warnings[].code`	string	Optional	—
`trust.warnings[].message`	string	Optional	—
`actions`	array of object	Required	—
`actions[].type`	string	Optional	—

Error responses (400, 422, 429, 503)

400 Malformed request
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "example code"
}'

Re-open a verification receipt(link to this endpoint)

No API key needed

GET/v1/verify/{ref}

A record of an earlier check (24 hours). It does not check the product in hand.

Parameters

Name	Type	Required	Rules
`ref`	string · path	Required	—

Responses

200 The stored result, with receipt view metadata · application/json · VerifyResult

Name	Type	Required	Rules
`outcome`	string	Required	One of: "verified", "unable_to_verify", "suspected_counterfeit", "recalled", "expired"
`checkedAt`	string (date-time)	Required	—
`referenceId`	string	Required	—
`product`	object \| null	Optional	—
`product.name`	string	Optional	—
`product.brand`	string	Optional	—
`product.imageUrl`	string \| null	Optional	—
`product.batchNumber`	string	Optional	—
`product.expiryDate`	string \| null	Optional	—
`product.manufacturerVerified`	boolean	Optional	—
`trust`	object	Required	—
`trust.scanCount`	integer	Optional	—
`trust.firstScan`	boolean	Optional	—
`trust.warnings`	array of object	Optional	—
`trust.warnings[].code`	string	Optional	—
`trust.warnings[].message`	string	Optional	—
`actions`	array of object	Required	—
`actions[].type`	string	Optional	—

Error responses (400, 422, 429, 503)

400 Malformed request
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/verify/REF"

Report a concern about a product(link to this endpoint)

No API key needed

POST/v1/reports

Request body (application/json, required)

Name	Type	Required	Rules
`referenceId`	string	Optional	Up to 64 characters
`type`	string	Required	One of: "fake", "damaged", "wrong_packaging", "suspicious_seller", "other"
`description`	string	Optional	Up to 2000 characters
`deviceId`	string	Optional	Up to 128 characters
`location`	object	Optional	No other fields allowed
`location.lat`	number	Required	Minimum -90 Maximum 90
`location.lon`	number	Required	Minimum -180 Maximum 180

Responses

202 Report accepted; returns a public reference · application/json

Error responses (400, 422, 429, 503)

400 Malformed request
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/reports" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "fake"
}'

Products

List products(link to this endpoint)

products:read

GET/v1/products

Parameters

Name	Type	Required	Rules
`search`	string · query	Optional	Up to 120 characters
`category`	string · query	Optional	Up to 60 characters
`status`	string · query	Optional	One of: "draft", "active", "discontinued", "recalled"
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 24

Responses

200 Cursor-paginated products · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/products" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Create a product(link to this endpoint)

products:write

POST/v1/products

Request body (application/json, required)

Name	Type	Required	Rules
`name`	string	Required	2–160 characters
`sku`	string	Required	1–80 characters
`gtin`	string	Optional	Up to 14 characters Pattern ^\d*$
`category`	string	Required	2–60 characters
`description`	string	Optional	Up to 4000 characters
`specs`	object	Optional	—
`packaging`	object	Optional	—
`orgUnitId`	string (uuid)	Optional	—

Responses

201 The created product · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/products" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example name",
  "sku": "example sku",
  "category": "example category"
}'

Export products as CSV(link to this endpoint)

products:read

GET/v1/products/export.csv

Responses

200 Streamed CSV · text/csv

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/products/export.csv" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a product(link to this endpoint)

products:read

GET/v1/products/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 The product with media · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/products/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Update a product(link to this endpoint)

products:write

PATCH/v1/products/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`name`	string	Optional	2–160 characters
`sku`	string	Optional	1–80 characters
`gtin`	string	Optional	Up to 14 characters Pattern ^\d*$
`category`	string	Optional	2–60 characters
`description`	string	Optional	Up to 4000 characters
`specs`	object	Optional	—
`packaging`	object	Optional	—
`orgUnitId`	string (uuid)	Optional	—
`status`	string	Optional	One of: "draft", "active", "discontinued"
`verificationEnabled`	boolean	Optional	—

Responses

200 The updated product · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X PATCH "https://api.credchek.com/v1/products/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example name",
  "sku": "example sku"
}'

Delete (discontinue) a product(link to this endpoint)

products:write

DELETE/v1/products/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Deleted · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X DELETE "https://api.credchek.com/v1/products/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

List a product’s batches(link to this endpoint)

products:read

GET/v1/products/{id}/batches

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Batches · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/products/ID/batches" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Create a batch(link to this endpoint)

products:write

POST/v1/products/{id}/batches

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`batchNumber`	string	Required	1–80 characters
`manufacturedDate`	string (date)	Optional	—
`expiryDate`	string (date)	Optional	—
`productionSite`	string	Optional	Up to 120 characters
`quantity`	integer	Optional	Greater than 0 Maximum 1,000,000,000

Responses

201 The created batch · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/products/ID/batches" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "batchNumber": "example batchNumber"
}'

Get a batch with stats(link to this endpoint)

products:read

GET/v1/batches/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Batch with codes generated, verified and suspicious counts · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/batches/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Recalls

Recall a batch(link to this endpoint)

recalls:write

POST/v1/batches/{id}/recall

Irreversible. Requires the batch number as confirmation. Consumers verifying affected codes are told to stop using the product.

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`reason`	string	Required	5–1000 characters
`classification`	string	Required	One of: "class_i", "class_ii", "class_iii"
`consumerMessage`	string	Optional	Up to 1000 characters
`replacementInfo`	string	Optional	Up to 1000 characters
`confirmBatchNumber`	string	Required	At least 1 characters

Responses

200 Recall initiated · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/batches/ID/recall" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "example reason",
  "classification": "class_i",
  "confirmBatchNumber": "example confirmBatchNumber"
}'

Codes

Generate codes for a batch(link to this endpoint)

codes:write

POST/v1/codes/generate

Starts an asynchronous job. Send an idempotencyKey so retries never duplicate a job.

Request body (application/json, required)

Name	Type	Required	Rules
`batchId`	string (uuid)	Required	—
`quantity`	integer	Required	Minimum 1 Maximum 5,000,000
`codeType`	string	Optional	One of: "qr", "serial", "scratch", "nfc", "datamatrix", "barcode" Default "qr"
`formatConfig`	object	Optional	—
`regionLock`	array of string	Optional	Up to 50 items Items match ^[A-Z]{2}$
`idempotencyKey`	string	Optional	8–120 characters

Responses

202 Job accepted · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/codes/generate" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "batchId": "batch-uuid",
  "quantity": 1,
  "idempotencyKey": "order-1234-run-1"
}'

List generation jobs(link to this endpoint)

codes:read

GET/v1/codes/jobs

Parameters

Name	Type	Required	Rules
`batchId`	string (uuid) · query	Optional	—

Responses

200 Jobs · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/jobs" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a generation job(link to this endpoint)

codes:read

GET/v1/codes/jobs/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Job progress and deliverable status · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/jobs/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Download the code deliverable (once)(link to this endpoint)

codes:export

GET/v1/codes/jobs/{id}/download

Plaintext serials. Single use and audited; requires the codes:export scope.

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 CSV of serials and QR URLs · text/csv

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/jobs/ID/download" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Import existing serials(link to this endpoint)

codes:write

POST/v1/codes/import

Request body (application/json, required)

Name	Type	Required	Rules
`batchId`	string (uuid)	Required	—
`serials`	array of string	Required	At least 1 items Up to 100000 items

Responses

200 Import summary · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/codes/import" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "batchId": "batch-uuid",
  "serials": [
    "example serials"
  ]
}'

Look up a code by serial(link to this endpoint)

codes:read

GET/v1/codes/lookup

Parameters

Name	Type	Required	Rules
`serial`	string · query	Required	1–120 characters

Responses

200 Code metadata (never the plaintext) · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/lookup?serial=example%20serial" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Code totals by status and type(link to this endpoint)

codes:read

GET/v1/codes/stats

Exact totals for the company, a product (productId) or a batch (batchId), from maintained counters.

Parameters

Name	Type	Required	Rules
`productId`	string (uuid) · query	Optional	—
`batchId`	string (uuid) · query	Optional	—

Responses

200 Totals, scanned count, generation volume and top products · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/stats" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Change status of many codes(link to this endpoint)

codes:write

POST/v1/codes/bulk-status

Request body (application/json, required)

Name	Type	Required	Rules
`batchId`	string (uuid)	Required	—
`from`	string	Optional	One of: "active", "suspended", "expired", "recalled", "void"
`to`	string	Required	One of: "active", "suspended", "expired", "recalled", "void"
`reason`	string	Optional	Up to 500 characters
`dryRun`	boolean	Optional	Default true

Responses

200 Affected count · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/codes/bulk-status" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "batchId": "batch-uuid",
  "to": "active"
}'

List codes(link to this endpoint)

codes:read

GET/v1/codes

Parameters

Name	Type	Required	Rules
`batchId`	string (uuid) · query	Optional	—
`productId`	string (uuid) · query	Optional	—
`status`	string · query	Optional	One of: "active", "suspended", "expired", "recalled", "void"
`codeType`	string · query	Optional	One of: "qr", "serial", "scratch", "nfc", "datamatrix", "barcode"
`search`	string · query	Optional	Up to 80 characters
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 50

Responses

200 Cursor-paginated code metadata · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a code(link to this endpoint)

codes:read

GET/v1/codes/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Code metadata · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/codes/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Suspend, void or reactivate a code(link to this endpoint)

codes:write

POST/v1/codes/{id}/status

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`status`	string	Required	One of: "active", "suspended", "expired", "recalled", "void"
`reason`	string	Optional	Up to 500 characters

Responses

200 Updated · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/codes/ID/status" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active"
}'

Analytics

Verification overview(link to this endpoint)

analytics:read

GET/v1/analytics/overview

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`from`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$
`to`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$

Responses

200 KPIs for the range · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/overview" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Verifications over time(link to this endpoint)

analytics:read

GET/v1/analytics/timeseries

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`bucket`	string · query	Optional	One of: "day", "week", "month" Default "day"
`split`	string · query	Optional	One of: "outcome", "channel", "first_repeat", "none" Default "none"

Responses

200 Series · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/timeseries" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Verifications by channel(link to this endpoint)

analytics:read

GET/v1/analytics/channel-mix

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`from`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$
`to`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$

Responses

200 Channel breakdown · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/channel-mix" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Verifications by place(link to this endpoint)

analytics:read

GET/v1/analytics/geo

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`level`	string · query	Optional	One of: "country" Default "country"

Responses

200 Geographic breakdown · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/geo" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Authenticity score(link to this endpoint)

analytics:read

GET/v1/analytics/authenticity-score

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"

Responses

200 Score and factors · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/authenticity-score" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Product analytics(link to this endpoint)

analytics:read

GET/v1/analytics/products/{productId}

Parameters

Name	Type	Required	Rules
`productId`	string · path	Required	—
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`from`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$
`to`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$

Responses

200 Product KPIs · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/products/PRODUCTID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Batch analytics(link to this endpoint)

analytics:read

GET/v1/analytics/batches/{batchId}

Parameters

Name	Type	Required	Rules
`batchId`	string · path	Required	—
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`from`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$
`to`	string · query	Optional	Pattern ^\d{4}-\d{2}-\d{2}$

Responses

200 Batch KPIs · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/batches/BATCHID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

List verification events(link to this endpoint)

analytics:read

GET/v1/analytics/events

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`productId`	string (uuid) · query	Optional	—
`batchId`	string (uuid) · query	Optional	—
`outcome`	string · query	Optional	One of: "verified", "unable_to_verify", "suspected_counterfeit", "recalled", "expired", "service_error"
`channel`	string · query	Optional	One of: "mobile_app", "web", "ussd", "sms", "whatsapp", "api", "retail_sdk"
`country`	string · query	Optional	2–2 characters
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 50

Responses

200 Cursor-paginated events · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/events" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Export verification events(link to this endpoint)

analytics:read

GET/v1/analytics/events/export.csv

Streams every event matching the filters as CSV. cursor and limit are ignored: the export is not paginated.

Parameters

Name	Type	Required	Rules
`range`	string · query	Optional	One of: "7d", "30d", "90d", "12mo" Default "30d"
`productId`	string (uuid) · query	Optional	—
`batchId`	string (uuid) · query	Optional	—
`outcome`	string · query	Optional	One of: "verified", "unable_to_verify", "suspected_counterfeit", "recalled", "expired", "service_error"
`channel`	string · query	Optional	One of: "mobile_app", "web", "ussd", "sms", "whatsapp", "api", "retail_sdk"
`country`	string · query	Optional	2–2 characters
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 50

Responses

200 Streamed CSV · text/csv

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/events/export.csv" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a verification event(link to this endpoint)

analytics:read

GET/v1/analytics/events/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Event detail · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/analytics/events/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Alerts

List fraud alerts(link to this endpoint)

alerts:read

GET/v1/fraud/alerts

Parameters

Name	Type	Required	Rules
`status`	string · query	Optional	One of: "open", "acknowledged", "investigating", "resolved", "false_positive"
`severity`	string · query	Optional	One of: "low", "medium", "high", "critical"
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 50

Responses

200 Alerts · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/fraud/alerts" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a fraud alert(link to this endpoint)

alerts:read

GET/v1/fraud/alerts/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Alert with evidence · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/fraud/alerts/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Update an alert’s status(link to this endpoint)

alerts:write

PATCH/v1/fraud/alerts/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`status`	string	Required	One of: "acknowledged", "investigating", "resolved", "false_positive"
`assignedTo`	string (uuid) \| null	Optional	—
`resolution`	string	Optional	Up to 500 characters

Responses

200 Updated alert · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X PATCH "https://api.credchek.com/v1/fraud/alerts/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "acknowledged"
}'

Consumer reports

List consumer reports(link to this endpoint)

reports:read

GET/v1/reports

Parameters

Name	Type	Required	Rules
`status`	string · query	Optional	One of: "submitted", "reviewing", "actioned", "dismissed"
`type`	string · query	Optional	One of: "fake", "damaged", "wrong_packaging", "suspicious_seller", "other"
`cursor`	string · query	Optional	—
`limit`	integer · query	Optional	Minimum 1 Maximum 100 Default 50

Responses

200 Reports · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/reports" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Report counts by status(link to this endpoint)

reports:read

GET/v1/reports/counts

Responses

200 Counts · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/reports/counts" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Get a report(link to this endpoint)

reports:read

GET/v1/reports/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 Report with timeline · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/reports/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Change a report’s status(link to this endpoint)

reports:write

PATCH/v1/reports/{id}/status

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`status`	string	Required	One of: "submitted", "reviewing", "actioned", "dismissed"

Responses

200 Updated · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X PATCH "https://api.credchek.com/v1/reports/ID/status" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "submitted"
}'

Reply to the consumer(link to this endpoint)

reports:write

POST/v1/reports/{id}/respond

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`message`	string	Required	1–1000 characters

Responses

200 Reply sent · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/reports/ID/respond" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "example message"
}'

Webhooks

List webhook endpoints(link to this endpoint)

webhooks:manage

GET/v1/webhooks

Responses

200 Endpoints (the signing secret is never listed; see secretHint) · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/webhooks" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Create a webhook endpoint(link to this endpoint)

webhooks:manage

POST/v1/webhooks

Public https URLs only. Deliveries are signed: X-CredCheck-Signature: t=<unix>,v1=<hex HMAC-SHA256 of "t.body">.

Request body (application/json, required)

Name	Type	Required	Rules
`url`	string (uri)	Required	Up to 500 characters
`events`	array of string	Required	At least 1 items Items one of: "fraud_alert_created", "fraud_alert_escalated", "recall_initiated", "code_job_completed", "report_received", "usage_threshold", "billing_event", "platform_maintenance"
`description`	string	Optional	Up to 200 characters

Responses

201 The endpoint, including its signing secret · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/webhooks" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/credcheck",
  "events": [
    "fraud_alert_created"
  ]
}'

Update a webhook endpoint(link to this endpoint)

webhooks:manage

PATCH/v1/webhooks/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Request body (application/json, required)

Name	Type	Required	Rules
`url`	string (uri)	Optional	Up to 500 characters
`events`	array of string	Optional	At least 1 items Items one of: "fraud_alert_created", "fraud_alert_escalated", "recall_initiated", "code_job_completed", "report_received", "usage_threshold", "billing_event", "platform_maintenance"
`description`	string	Optional	Up to 200 characters
`enabled`	boolean	Optional	—

Responses

200 Updated · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X PATCH "https://api.credchek.com/v1/webhooks/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/credcheck",
  "events": [
    "fraud_alert_created"
  ]
}'

Delete a webhook endpoint(link to this endpoint)

webhooks:manage

DELETE/v1/webhooks/{id}

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

204 Deleted (no body)

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X DELETE "https://api.credchek.com/v1/webhooks/ID" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Rotate the signing secret(link to this endpoint)

webhooks:manage

POST/v1/webhooks/{id}/rotate-secret

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

200 The endpoint with its new signing secret, shown once · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/webhooks/ID/rotate-secret" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Send a test delivery(link to this endpoint)

webhooks:manage

POST/v1/webhooks/{id}/test

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

202 Test delivery queued; returns its delivery id · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/webhooks/ID/test" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

List deliveries(link to this endpoint)

webhooks:manage

GET/v1/webhooks/deliveries

Parameters

Name	Type	Required	Rules
`endpointId`	string (uuid) · query	Optional	—

Responses

200 Recent deliveries with status · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/webhooks/deliveries" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Replay a delivery(link to this endpoint)

webhooks:manage

POST/v1/webhooks/deliveries/{id}/replay

Parameters

Name	Type	Required	Rules
`id`	string · path	Required	—

Responses

202 Delivery re-queued · application/json

Error responses (400, 401, 403, 404, 422, 429, 503)

400 Malformed request
401 Missing, invalid, expired or revoked API key
403 Key lacks the scope, or the route is not available to API keys
404 Not found (or not in your company)
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X POST "https://api.credchek.com/v1/webhooks/deliveries/ID/replay" \
  -H "X-Api-Key: $CREDCHECK_API_KEY"

Platform

Service status(link to this endpoint)

No API key needed

GET/v1/public/status

Responses

200 Component states, 90-day uptime and incidents · application/json

Error responses (400, 422, 429, 503)

400 Malformed request
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/public/status"

Plans and prices(link to this endpoint)

No API key needed

GET/v1/public/plans

Responses

200 Active plans with current prices · application/json

Error responses (400, 422, 429, 503)

400 Malformed request
422 Validation failed
429 Rate limited (see Retry-After) · header Retry-After
503 Temporarily overloaded — retry once after Retry-After (code overloaded) · header Retry-After

Errors use the standard envelope. See errors and rate limits.

Example request (curl)

curl -X GET "https://api.credchek.com/v1/public/plans"