{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"363a596e-9cb7-463d-ad41-0d544d48ee3a","name":"PSBI Partner API","description":"# PSBI Partner API\n\nThe PSBI Partner API provides a secure, RESTful interface for partners to integrate with PSBI's background screening and compliance management platform. This collection includes:\n\n- **Partner Gateway** - Submit background check transactions and retrieve results\n- **AutoPilot API** - Automated consumer enrollment and position management\n\n## Base URL\n```\nhttps://api.psbi.com\n```\n\n## Authentication\n\nAll API requests require authentication using an API key provided by the PSBI implementation team. Include your key in the request header:\n\n```\nX-API-Key: your-api-key-here\n```\n\n## API Sections\n\n### Partner Gateway\nCore transaction processing for background checks:\n- Create consumer and client transactions\n- Check transaction status\n- Download documents and reports\n\n### AutoPilot API\nAutomated compliance position management:\n- Enroll consumers into positions (checklists)\n- Transition consumers between positions\n- Track enrollment status\n\n## Key Concepts\n\n### Transactions\nA transaction represents a background check request. Types include:\n- **Consumer**: Consumer receives onboarding email\n- **Client**: Internal processing by your team\n\n### Checklists (Positions)\nA checklist defines compliance requirements for a position (e.g., \"Caregiver\", \"Driver\"). Each checklist specifies required background checks.\n\n### Enrollment Paths\nHow a consumer is onboarded:\n- **email_onboarding**: Consumer receives email to complete profile\n- **email_consent**: Consumer receives consent-only email\n- **instant**: Process immediately with available data\n- **manual_entry**: Create task for internal staff\n- **enroll_only**: Create enrollment without transaction\n\n## Request Format\n\n- All requests must include `Content-Type: application/json` header\n- Request bodies must be valid JSON\n- Dates should be in ISO 8601 format (YYYY-MM-DD)\n\n## Response Format\n\nAll responses include:\n- `success`: Boolean indicating request success\n- `error`: Error details (only when success is false)\n\n## Rate Limiting\n\nAPI requests are rate limited to 100 requests per minute. Contact support for higher limits.\n\n## Support\n\nFor technical support or questions about this API, contact your PSBI implementation team or email integrations@psbi.com.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"44933307","team":7811338,"collectionId":"363a596e-9cb7-463d-ad41-0d544d48ee3a","publishedId":"2sBXVbJuYQ","public":true,"publicUrl":"https://apis.psbi.com","privateUrl":"https://go.postman.co/documentation/44933307-363a596e-9cb7-463d-ad41-0d544d48ee3a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5643AD"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Integrate background screening and compliance management into your systems. The Partner Gateway handles background check transactions while the AutoPilot API automates employee enrollment and position management. RESTful endpoints with sync and async processing options."},{"name":"title","value":"PSBI Partner API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b71632a5-b5f6-4356-976f-91605320c685/UHJlU2VhcmNoIEZpbmFsIHYzIEludmVydGVkLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"5643AD"}},{"name":"light","logo":"https://content.pstmn.io/fefb03ec-6884-4f06-8d4d-dd794fcaed3f/UHJlU2VhcmNoIEZpbmFsIHYzLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5643AD"}}]}},"version":"8.10.1","publishDate":"2025-12-31T20:25:08.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"PSBI Partner API Documentation","description":"Integrate background screening and compliance management into your systems. The Partner Gateway handles background check transactions while the AutoPilot API automates employee enrollment and position management. RESTful endpoints with sync and async processing options."},"logos":{"logoLight":"https://content.pstmn.io/fefb03ec-6884-4f06-8d4d-dd794fcaed3f/UHJlU2VhcmNoIEZpbmFsIHYzLnBuZw==","logoDark":"https://content.pstmn.io/b71632a5-b5f6-4356-976f-91605320c685/UHJlU2VhcmNoIEZpbmFsIHYzIEludmVydGVkLnBuZw=="}},"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://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/ea1a80aa9fe24897425a201014bded42f885f00178d48e6fdadd20e32bd91a09","favicon":"https://psbi.com/favicon.ico"},"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://apis.psbi.com/view/metadata/2sBXVbJuYQ"}