{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b0091fa1-fd5f-4d7e-8e67-e9ba3e3bdde5","name":"Christian Background Checks Partner API","description":"**Start in the sandbox.** `baseUrl` points at the sandbox (`https://dev.partners.cbgc.io`): checks there are\nsimulated and never billed. Set `apiKey` to your `pk_test_...` key (get one at [join.cbgc.io](https://join.cbgc.io/#contact)).\nSwitch `baseUrl` to `{{productionBaseUrl}}` with a `pk_live_...` key only when you go live. Keep keys in your\nPostman vault or environment, never in a shared collection.\n\nOrder and track background checks for the churches you serve, from your own platform. Connect a church once\n(on a page we host, or with one API call), then order checks by name and email: we email each applicant to\ncollect their details and consent, and send you signed webhooks as checks progress. You never handle SSNs,\ndates of birth, card numbers or passwords.\n\nFull guide: [/docs/guide.md](https://partners.cbgc.io/docs/guide.md) · error catalog:\n[/docs/errors.md](https://partners.cbgc.io/docs/errors.md) · for AI agents: [/llms.txt](https://partners.cbgc.io/llms.txt)\nand [/llms-full.txt](https://partners.cbgc.io/llms-full.txt) (everything in one file).\n\n## How it works (start here)\n| Environment | Base URL | API keys | Checks |\n|---|---|---|---|\n| Test (sandbox) | `https://dev.partners.cbgc.io` | `pk_test_...` | Not real; nothing is charged |\n| Production | `https://partners.cbgc.io` | `pk_live_...` | Real and billed |\n\n1. `GET /status` with your test key: `200` means it works.\n2. `PUT /settings` with your webhook URL and connect return URL.\n3. Connect a church: `POST /connect/sessions` and send its browser to `connectUrl` (or `POST /clients`).\n4. `GET /products`, then `POST /clients/{clientRef}/checks` with a `level` (1 to 6).\n5. Handle `check.updated` webhooks, and reconcile nightly with `GET /clients/{clientRef}/checks`.\n\n## Concepts\n- **Client**: one church. Address it as `{clientRef}`: our `clientId` or your own `externalClientId`.\n- **Check**: one background check for one applicant, with a contract-stable `status` and a finer `stage`.\n  Use `externalIdentifier` (your id, unique across all your clients) to match it to your records.\n- **Level**: products are levels 1 to 6 (`GET /products`). We translate a level to each church's own product.\n- **Batch**: up to 500 checks in one call. **Connect session**: one run of the hosted connect page for one church.\n\n## Authentication\nSend your API key on every request as `X-Api-Key: <key>` or `Authorization: Bearer <key>`. Keys are issued by Datasource,\nshown once, and belong in a secret manager (never in browser or app code). You can have two active keys, so you\ncan rotate without downtime. Repeated invalid keys from one IP address are answered with `429 rate_limited` for a\nminute; requests with a valid key are never throttled that way.\n\n## Conventions\n- JSON in and out, camelCase names, UTC ISO 8601 timestamps.\n- Errors are [RFC 9457 problem details](https://www.rfc-editor.org/rfc/rfc9457) with a stable `code` and a `type`\n  link to its catalog entry. Branch on `code`. Two documented bodies aren't problem details: `409 duplicate_check`\n  (the existing check) and `502` on ordering (the `PENDING` check).\n- Always send an `externalIdentifier` and reuse it on retries: a retry never creates a second check or bill.\n- Ignore fields and webhook events you don't know. Changes are additive; a breaking change gets 90 days' notice in\n  the changelog (`/docs/changelog.md`).\n\n## Compliance\nDatasource is the consumer reporting agency. The church is the end user and makes, and is responsible for, all decisions,\nincluding adverse action, which is handled in its portal.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"60196321","team":47362444,"collectionId":"b0091fa1-fd5f-4d7e-8e67-e9ba3e3bdde5","publishedId":"2sBYHaQHM3","public":true,"publicUrl":"https://documenter-api.postman.tech/view/60196321/2sBYHaQHM3","privateUrl":"https://go.postman.co/documentation/60196321-b0091fa1-fd5f-4d7e-8e67-e9ba3e3bdde5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.12","publishDate":"2026-11-14T18:08:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/t_team_logo_pubdoc/v1/team/da4fd632cab820a04c40a5f841972460039c04fc5c8329ae6843201c59b3a855","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYHaQHM3"}