{"info":{"_postman_id":"363a596e-9cb7-463d-ad41-0d544d48ee3a","name":"PSBI Partner API","description":"

PSBI Partner API

The PSBI Partner API provides a secure, RESTful interface for partners to integrate with PSBI's background screening and compliance management platform. This collection includes:

Partner Gateway - Submit background check transactions and retrieve results
AutoPilot API - Automated consumer enrollment and position management

Base URL

https://api.psbi.com\n

Authentication

All API requests require authentication using an API key provided by the PSBI implementation team. Include your key in the request header:

X-API-Key: your-api-key-here\n

API Sections

Partner Gateway

Core transaction processing for background checks:

Create consumer and client transactions
Check transaction status
Download documents and reports

AutoPilot API

Automated compliance position management:

Enroll consumers into positions (checklists)
Transition consumers between positions
Track enrollment status

Key Concepts

Transactions

A transaction represents a background check request. Types include:

Consumer: Consumer receives onboarding email
Client: Internal processing by your team

Checklists (Positions)

A checklist defines compliance requirements for a position (e.g., \"Caregiver\", \"Driver\"). Each checklist specifies required background checks.

Enrollment Paths

How a consumer is onboarded:

email_onboarding: Consumer receives email to complete profile
email_consent: Consumer receives consent-only email
instant: Process immediately with available data
manual_entry: Create task for internal staff
enroll_only: Create enrollment without transaction

Request Format

All requests must include Content-Type: application/json header
Request bodies must be valid JSON
Dates should be in ISO 8601 format (YYYY-MM-DD)

Response Format

All responses include:

success: Boolean indicating request success
error: Error details (only when success is false)

Rate Limiting

API requests are rate limited to 100 requests per minute. Contact support for higher limits.

Support

For technical support or questions about this API, contact your PSBI implementation team or email integrations@psbi.com.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"PSBI Partner API","slug":"psbi-partner-api"}],"owner":"44933307","collectionId":"363a596e-9cb7-463d-ad41-0d544d48ee3a","publishedId":"2sBXVbJuYQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"5643AD"},"publishDate":"2025-12-31T20:25:08.000Z"},"item":[{"name":"Authentication","item":[{"name":"Test Authentication","event":[{"listen":"test","script":{"exec":["pm.test(\"Authentication successful\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});","","if (pm.response.code === 404) {"," pm.test(\"Response shows not found (auth worked)\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.false;"," });","}"],"type":"text/javascript","id":"1b91a7a6-98a2-49f4-9efa-cf93f7f407e4"}}],"id":"801e9634-ce62-47ca-a06b-59d0e531b90a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/test-auth-check","description":"

Test your API authentication by attempting to fetch a non-existent resource.

Expected Response:

404 with not found error if authentication is successful
401 with authentication error if credentials are invalid

This endpoint is useful for verifying your API key is working before submitting actual requests.

\n","urlObject":{"path":["api","v1","partners","transactions","test-auth-check"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"a7521366-62e0-4b97-9317-c720f549617d","name":"Authentication Success","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/test-auth-check"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"TRANSACTION_NOT_FOUND\",\n \"message\": \"Transaction not found\"\n }\n}"},{"id":"32302365-d4fb-48fe-a5a5-670735d621b1","name":"Authentication Failed","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"invalid-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/test-auth-check"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"INVALID_API_KEY\",\n \"message\": \"Invalid API key provided\"\n }\n}"}],"_postman_id":"801e9634-ce62-47ca-a06b-59d0e531b90a"}],"id":"9929f8ed-2fc1-4fb1-a0f2-f9cbf1aed4ea","description":"

Test your API credentials before making requests.

\n","_postman_id":"9929f8ed-2fc1-4fb1-a0f2-f9cbf1aed4ea"},{"name":"Partner Gateway","item":[{"name":"Transactions","item":[{"name":"Create Consumer Transaction","event":[{"listen":"test","script":{"exec":["pm.test(\"Transaction created successfully\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response indicates success\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;","});","","pm.test(\"Has external ID\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('external_id');","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_gateway_external_id', pm.response.json().external_id);","}"],"type":"text/javascript","id":"11c1a907-b071-4491-aaad-1d8aab5c15f4"}}],"id":"5f140a35-cbbd-46cd-a1f2-33b54eb9328b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_357\",\n \"transaction_type\": \"consumer\",\n \"consumer\": {\n \"first_name\": \"Ezekiel\",\n \"last_name\": \"Weissnat\",\n \"email\": \"Janet31@gmail.com\",\n \"phone\": \"537-884-0865\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": \"1990-01-15\",\n \"address\": \"456 Oak Avenue\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\"\n },\n \"products\": [\"Statewide Criminal\", \"Sex Offender Registry\"],\n \"notes\": \"Consumer onboarding transaction\",\n \"priority\": \"normal\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/transactions","description":"

Create a new consumer transaction for background check processing.

Consumer Transactions

Consumer transactions send an onboarding email to the consumer, allowing them to:

Complete their profile information
Provide consent for background checks
Upload any required documents

Required Fields

consumer.first_name: Consumer's first name
consumer.last_name: Consumer's last name
consumer.email: Valid email address
products: Array of product names or IDs

Optional Fields

external_id: Your unique tracking ID
consumer.phone, consumer.ssn, consumer.date_of_birth
consumer.address, consumer.city, consumer.state, consumer.zip
notes: Additional notes
priority: low, normal, high, urgent

Products

Specify products by name or ID:

\"County Criminal\"
\"National Criminal\"
\"Statewide Criminal\"
\"Sex Offender Registry\"
\"SSN Trace\"
\"Employment Verification\"
\"Education Verification\"

\n","urlObject":{"path":["api","v1","partners","transactions"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"b4059c4d-7c89-4b1e-998a-e70e093a2fc3","name":"Consumer Transaction Created","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_12345\",\n \"transaction_type\": \"consumer\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"555-123-4567\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": \"1990-01-15\",\n \"address\": \"456 Oak Avenue\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\"\n },\n \"products\": [\"Statewide Criminal\", \"Sex Offender Registry\"],\n \"notes\": \"Consumer onboarding transaction\",\n \"priority\": \"normal\"\n}"},"url":"https://api.psbi.com/api/v1/partners/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": \"PTX-12345\",\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"received\",\n \"estimated_completion\": \"2025-01-20T10:00:00Z\",\n \"task_url\": \"https://app.psbi.com/consumer/complete-profile/abc123def456\",\n \"message\": \"Consumer transaction created successfully. Email sent to consumer for profile completion.\"\n}"},{"id":"b4f96a28-ce60-4d79-8bf7-a4ac4653018c","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\"\n }\n}"},"url":"https://api.psbi.com/api/v1/partners/transactions"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"The provided data is invalid\",\n \"details\": {\n \"consumer.last_name\": [\"Consumer last name is required\"],\n \"consumer.email\": [\"Consumer email is required\"],\n \"products\": [\"At least one product is required\"]\n }\n }\n}"}],"_postman_id":"5f140a35-cbbd-46cd-a1f2-33b54eb9328b"},{"name":"Create Client Transaction","event":[{"listen":"test","script":{"exec":["pm.test(\"Transaction created successfully\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response indicates success\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_gateway_external_id', pm.response.json().external_id);","}"],"type":"text/javascript","id":"76b7d24e-57ac-4c05-88f4-ce8fcee68fc6"}}],"id":"c315239d-3702-40df-a48c-0ea03bd9d94d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CLIENT_499\",\n \"transaction_type\": \"client\",\n \"consumer\": {\n \"first_name\": \"Cristal\",\n \"last_name\": \"Gleichner\",\n \"email\": \"Kris_Barrows@yahoo.com\",\n \"phone\": \"753-391-1535\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": \"1985-03-22\",\n \"address\": \"789 Pine Street\",\n \"city\": \"Houston\",\n \"state\": \"TX\",\n \"zip\": \"77001\"\n },\n \"products\": [\"County Criminal\", \"National Criminal\", \"Employment Verification\"],\n \"notes\": \"Client information task - priority processing needed\",\n \"priority\": \"high\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/transactions","description":"

Create a client transaction for internal processing.

Client vs Consumer Transactions

Client transactions are handled differently:

No Consumer Email: Consumer does not receive onboarding email
Internal Processing: Creates task for your team to process
Manual Data Entry: Staff enters consumer data manually

Use Cases

Bulk processing where you handle consumer communication
Complex cases requiring manual review
Situations where consumer cannot complete self-service

Request Format

Identical to consumer transactions, but with transaction_type set to \"client\".

\n","urlObject":{"path":["api","v1","partners","transactions"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"3b9f79a3-da35-4d2a-9fcc-3b7ddc10d5fc","name":"Client Transaction Created","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CLIENT_67890\",\n \"transaction_type\": \"client\",\n \"consumer\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jane.smith@example.com\"\n },\n \"products\": [\"County Criminal\", \"National Criminal\"],\n \"priority\": \"high\"\n}"},"url":"https://api.psbi.com/api/v1/partners/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": \"PTX-67890\",\n \"external_id\": \"CLIENT_67890\",\n \"status\": \"received\",\n \"estimated_completion\": \"2025-01-22T14:00:00Z\",\n \"message\": \"Client transaction created successfully. Internal task assigned for processing.\"\n}"}],"_postman_id":"c315239d-3702-40df-a48c-0ea03bd9d94d"},{"name":"Get Transaction Status","event":[{"listen":"test","script":{"exec":["pm.test(\"Status request successful\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});","","if (pm.response.code === 200) {"," pm.test(\"Has transaction details\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.transaction).to.have.property('status');"," });","}"],"type":"text/javascript","id":"61b7e30d-dcdd-4ea0-8dee-3dc7649c4856"}}],"id":"d3577c6c-de51-4bf3-ae58-360a8f2f8f1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/","description":"

Retrieve the current status and details of a transaction.

URL Parameter

external_id: Your external ID provided when creating the transaction

Transaction Statuses

received: Transaction received and queued
processing: Currently being processed
completed: Processing completed successfully
failed: Processing failed
cancelled: Transaction was cancelled

Consumer Transaction Statuses

pending: Waiting for consumer to complete profile
in_progress: Consumer has started but not completed
submitted: Consumer has submitted information
review: Under review
complete: Background check completed

\n","urlObject":{"path":["api","v1","partners","transactions",""],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"f470176b-22ce-4f6b-9a7b-de9f037b2b62","name":"Transaction Status - In Progress","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/CONSUMER_12345"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction\": {\n \"id\": \"PTX-12345\",\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"processing\",\n \"transaction_type\": \"consumer\",\n \"received_at\": \"2025-01-15T09:30:00Z\",\n \"processed_at\": null,\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"submitted\",\n \"estimated_total\": 45.00,\n \"submitted_at\": \"2025-01-16T14:22:00Z\",\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\"\n }\n }\n }\n}"},{"id":"4d3d2492-8ee9-442a-8e95-7ee65131cf50","name":"Transaction Not Found","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/INVALID_ID"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"TRANSACTION_NOT_FOUND\",\n \"message\": \"Transaction not found\"\n }\n}"}],"_postman_id":"d3577c6c-de51-4bf3-ae58-360a8f2f8f1f"}],"id":"c860c949-fe92-46e0-b5c4-23d60fbb7509","description":"

Create and track background check transactions.

\n","_postman_id":"c860c949-fe92-46e0-b5c4-23d60fbb7509"},{"name":"Documents","item":[{"name":"Get Transaction Documents","event":[{"listen":"test","script":{"exec":["pm.test(\"Documents retrieved\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});","","if (pm.response.code === 200 && pm.response.json().documents && pm.response.json().documents.length > 0) {"," pm.environment.set('first_document_id', pm.response.json().documents[0].id);","}"],"type":"text/javascript","id":"49a61065-7711-434a-84f8-292115706350"}}],"id":"40d0a8e7-6481-4d27-acf8-b6916a44c091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions//documents","description":"

Retrieve all documents associated with a transaction.

Document Types

generated_report: System-generated background check reports
completion_report: Final report when transaction completes
uploaded_document: Documents uploaded during process

Security

Document access is scoped to your account
Download URLs are temporary and expire
All transfers are encrypted

\n","urlObject":{"path":["api","v1","partners","transactions","","documents"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"82645ddd-f9aa-4838-b9ff-7ef0ac716ff5","name":"Documents Retrieved","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/transactions/CONSUMER_12345/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"documents\": [\n {\n \"id\": \"doc_abc123def456\",\n \"filename\": \"Background Check Report - John Doe.pdf\",\n \"document_type\": \"completion_report\",\n \"mime_type\": \"application/pdf\",\n \"size\": 245760,\n \"created_at\": \"2025-01-20T11:45:15Z\",\n \"download_url\": \"https://api.psbi.com/api/v1/partners/documents/doc_abc123def456/download?token=...\",\n \"expires_at\": \"2025-01-21T11:45:15Z\"\n }\n ],\n \"total_count\": 1\n}"}],"_postman_id":"40d0a8e7-6481-4d27-acf8-b6916a44c091"},{"name":"Download Document","event":[{"listen":"test","script":{"exec":["pm.test(\"Document download successful\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});"],"type":"text/javascript","id":"e61a95ff-e6f6-4197-9e94-629bd60df73b"}}],"id":"0e08e579-277e-48ee-8cac-b432b839d022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/documents//download","description":"

Download a specific document by ID.

Response

Returns binary content with appropriate headers:

Content-Type: MIME type (e.g., application/pdf)
Content-Disposition: Attachment with filename

Security

Documents can only be accessed by the account that created the transaction
All downloads are logged for audit purposes

\n","urlObject":{"path":["api","v1","partners","documents","","download"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"ae4b43a4-0083-417f-bff2-41ce4efa50ac","name":"Document Downloaded","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/documents/doc_abc123/download"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Content-Type","value":"application/pdf"},{"key":"Content-Disposition","value":"attachment; filename=\"Background Check Report.pdf\""}],"cookie":[],"responseTime":null,"body":"%PDF-1.4 Binary PDF content..."}],"_postman_id":"0e08e579-277e-48ee-8cac-b432b839d022"}],"id":"6e030587-bf3f-4d80-b70b-aa1d0b86d627","description":"

Retrieve and download documents from completed transactions.

\n","_postman_id":"6e030587-bf3f-4d80-b70b-aa1d0b86d627"}],"id":"605beb76-06d1-46bc-ab14-fc23ac83037f","description":"

Partner Gateway

The Partner Gateway API enables submission and tracking of background check transactions.

Transaction Types

Consumer: Consumer receives email to complete profile
Client: Internal processing by your team

Workflow

Create Transaction - Submit consumer data and products
Consumer Completes Profile (consumer type only)
Check Status - Poll for completion
Download Documents - Retrieve reports when complete

\n","_postman_id":"605beb76-06d1-46bc-ab14-fc23ac83037f"},{"name":"AutoPilot API","item":[{"name":"Enrollment","item":[{"name":"Enroll Consumer (Minimal)","event":[{"listen":"test","script":{"exec":["pm.test(\"Enrollment request accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);","});","","pm.test(\"Response indicates success\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.success).to.be.true;","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_autopilot_external_id', pm.response.json().external_id);","}","","if (pm.response.json().consumer && pm.response.json().consumer.id) {"," pm.environment.set('last_consumer_id', pm.response.json().consumer.id);","}"],"type":"text/javascript","id":"1858ffa3-5992-40be-9b2c-8630389a2f6d"}}],"id":"79644562-7799-4c07-ae07-a661c9eda384","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"Marc\",\n \"last_name\": \"Lehner\",\n \"email\": \"Laverne2@yahoo.com\"\n },\n \"checklist_code\": \"Caregiver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll","description":"

Enroll a consumer with minimum required fields.

Minimum Required Fields

consumer.first_name
consumer.last_name
consumer.email
checklist_code OR checklist_id

Default Behavior

Enrollment Path: email_onboarding - Consumer receives email
Processing: Asynchronous - Returns immediately
Consumer Matching: Matches by email + last name, creates if not found
Transaction: Created automatically

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"7efb7067-4690-4702-a54c-46109f7fa77d","name":"Enrollment Accepted (Async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"checklist_code\": \"Caregiver\"\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 1234,\n \"external_id\": \"ext_ap_678def456abc\",\n \"status\": \"received\",\n \"message\": \"Enrollment request queued for processing\",\n \"received_at\": \"2025-01-15T10:30:00Z\"\n}"}],"_postman_id":"79644562-7799-4c07-ae07-a661c9eda384"},{"name":"Enroll Consumer (Full - Sync)","event":[{"listen":"test","script":{"exec":["pm.test(\"Enrollment processed successfully\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Has enrollment details\", function () {"," var jsonData = pm.response.json();"," if (jsonData.success) {"," pm.expect(jsonData).to.have.property('enrollment');"," }","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_autopilot_external_id', pm.response.json().external_id);","}","","if (pm.response.json().consumer && pm.response.json().consumer.id) {"," pm.environment.set('last_consumer_id', pm.response.json().consumer.id);","}"],"type":"text/javascript","id":"9292e8ca-b823-4eeb-ac59-dbf35130fd6a"}}],"id":"da870412-46c3-49f3-ac40-5a7f8250513b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2025-746\",\n \"consumer\": {\n \"first_name\": \"Alexander\",\n \"last_name\": \"Yost\",\n \"email\": \"Maude_Goldner10@hotmail.com\",\n \"phone\": \"760-704-8266\",\n \"ssn\": \"09664869\",\n \"date_of_birth\": \"1990-05-15\",\n \"address\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\"\n },\n \"checklist_id\": 4,\n \"tag_codes\": [\"DOT\"],\n \"enrollment_path\": \"instant\",\n \"user_email\": \"hiring.manager@company.com\",\n \"sync\": true,\n \"metadata\": {\n \"department\": \"Nursing\",\n \"hire_date\": \"2025-02-01\"\n },\n \"notes\": \"New hire for ICU department\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll","description":"

Enroll a consumer with all options and synchronous processing.

All Available Fields

Consumer Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
`first_name`	Yes	First name
`last_name`	Yes	Last name
`email`	Yes	Email address
`phone`	No	Phone number
`ssn`	No	SSN for matching
`date_of_birth`	No	YYYY-MM-DD
`address`, `city`, `state`, `zip`	No	Address fields

Options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`checklist_id` or `checklist_code`	Position to enroll in
`tag_ids` or `tag_codes`	Additional requirement tags
`enrollment_path`	Processing path (see below)
`user_email`	Submitting user's email
`sync`	Process synchronously
`metadata`	Custom metadata

Enrollment Paths

email_onboarding (default): Consumer receives email
email_consent: Consent-only email
instant: Process immediately with client task
manual_entry: Create task for staff
enroll_only: Create enrollment without transaction

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"62638311-bb5e-4c53-bd35-67a505a32377","name":"Enrollment Processed (Sync)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2025-001234\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"ssn\": \"123456789\"\n },\n \"checklist_id\": 4,\n \"enrollment_path\": \"instant\",\n \"sync\": true\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 1234,\n \"external_id\": \"HR-2025-001234\",\n \"status\": \"processed\",\n \"enrollment\": {\n \"id\": 108,\n \"checklist_id\": 4,\n \"checklist_name\": \"Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2025-01-15T10:30:00Z\"\n },\n \"consumer\": {\n \"id\": 1461,\n \"name\": \"John Doe\",\n \"created\": false\n },\n \"transaction\": {\n \"id\": 5678,\n \"status\": \"processing\",\n \"search_count\": 5,\n \"pending_requirements\": false\n },\n \"task\": {\n \"id\": 9012,\n \"type\": \"client_info\",\n \"url\": null\n },\n \"received_at\": \"2025-01-15T10:30:00Z\"\n}"},{"id":"9a821383-e289-4b31-850d-d807d43efa50","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\"\n }\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"The provided data is invalid\",\n \"details\": {\n \"consumer.last_name\": [\"Consumer last name is required\"],\n \"consumer.email\": [\"Consumer email is required\"],\n \"checklist_id\": [\"Either checklist_id or checklist_code is required\"]\n }\n }\n}"},{"id":"36a2405f-bb2a-40d6-85b5-55f575a47dc1","name":"Checklist Not Found","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"checklist_code\": \"Invalid Position\"\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"CHECKLIST_NOT_FOUND\",\n \"message\": \"Checklist not found: Invalid Position\"\n }\n}"}],"_postman_id":"da870412-46c3-49f3-ac40-5a7f8250513b"},{"name":"Enroll Consumer (Enroll Only)","event":[{"listen":"test","script":{"exec":["pm.test(\"Enrollment processed\", function () {"," pm.response.to.have.status(200);","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_autopilot_external_id', pm.response.json().external_id);","}"],"type":"text/javascript","id":"fbb86d96-e2cb-457e-8fb6-ef94086d7806"}}],"id":"197664a0-ac7b-4d1a-8b23-65321ae3092b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"ENROLL-ONLY-639\",\n \"consumer\": {\n \"first_name\": \"Nicola\",\n \"last_name\": \"Stoltenberg\",\n \"email\": \"Janessa_Farrell61@gmail.com\"\n },\n \"checklist_code\": \"Caregiver\",\n \"enrollment_path\": \"enroll_only\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll","description":"

Create an enrollment without initiating a background check.

Use Case

The enroll_only path is useful when you want to:

Track position assignments without running checks
Import existing employees
Set up compliance tracking before hire date

Behavior

Creates enrollment record
Initializes compliance requirement tracking
Does NOT create a background check transaction
Does NOT send emails to consumer
Requirements show as \"never completed\"

Follow-up

Later trigger a background check via the transition endpoint.

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"6d09c92e-670b-401f-b40c-199b7754cde8","name":"Enrollment Created (No Transaction)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"ENROLL-ONLY-12345\",\n \"consumer\": {\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\",\n \"email\": \"jane.smith@example.com\"\n },\n \"checklist_code\": \"Caregiver\",\n \"enrollment_path\": \"enroll_only\",\n \"sync\": true\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/enroll"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 1236,\n \"external_id\": \"ENROLL-ONLY-12345\",\n \"status\": \"processed\",\n \"enrollment\": {\n \"id\": 109,\n \"checklist_id\": 4,\n \"checklist_name\": \"Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2025-01-15T11:00:00Z\"\n },\n \"consumer\": {\n \"id\": 1462,\n \"name\": \"Jane Smith\",\n \"created\": true\n },\n \"transaction\": {\n \"id\": null,\n \"status\": null,\n \"search_count\": 0,\n \"pending_requirements\": true\n },\n \"task\": null,\n \"received_at\": \"2025-01-15T11:00:00Z\"\n}"}],"_postman_id":"197664a0-ac7b-4d1a-8b23-65321ae3092b"}],"id":"c03e260f-6ab6-4c0e-8201-69cbe3e165a8","description":"

Enroll consumers into compliance positions (checklists).

\n","_postman_id":"c03e260f-6ab6-4c0e-8201-69cbe3e165a8"},{"name":"Transition","item":[{"name":"Transition by Consumer ID","event":[{"listen":"test","script":{"exec":["pm.test(\"Transition request accepted\", function () {"," pm.expect([200, 202, 400, 404]).to.include(pm.response.code);","});","","if (pm.response.json().external_id) {"," pm.environment.set('last_transition_id', pm.response.json().external_id);","}"],"type":"text/javascript","id":"1f9a33f6-5db5-4343-a646-9a91b3e879ac"}}],"id":"936d8436-e676-40f7-8dbc-ba1d9e8656bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer_id\": ,\n \"new_checklist_code\": \"Mobile Caregiver\",\n \"external_id\": \"TRANSITION-960\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/autopilot/transition","description":"

Transition a consumer to a new position using their consumer ID.

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Required	Description
`consumer_id`	Yes*	Consumer's ID
`new_checklist_id` or `new_checklist_code`	Yes	Target position
`external_id`	No	Your tracking ID
`sync`	No	Process synchronously

*Either consumer_id OR consumer object is required.

Transition Logic

The system performs smart differential analysis:

Finds current enrollment
Compares requirements between positions
Reuses valid compliance - copies over valid records
Creates transaction - only for net-new requirements
Supersedes old enrollment

Response Fields

transition.reused_count: Compliance records reused
transition.net_new_count: New requirements added
transition.transaction_id: Transaction for new requirements (null if none)

\n","urlObject":{"path":["api","v1","partners","autopilot","transition"],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"c372d996-e940-4c74-aeba-229551196b00","name":"Transition Successful","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer_id\": 1461,\n \"new_checklist_code\": \"Mobile Caregiver\",\n \"external_id\": \"TRANSITION-001234\",\n \"sync\": true\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/transition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 1237,\n \"external_id\": \"TRANSITION-001234\",\n \"status\": \"processed\",\n \"enrollment\": {\n \"id\": 110,\n \"checklist_id\": 11,\n \"checklist_name\": \"Mobile Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2025-01-15T14:30:00Z\"\n },\n \"consumer\": {\n \"id\": 1461,\n \"name\": \"John Doe\"\n },\n \"transition\": {\n \"reused_count\": 3,\n \"net_new_count\": 2,\n \"transaction_id\": 5680,\n \"message\": \"Position transition created with 2 new requirements (3 reused)\"\n },\n \"received_at\": \"2025-01-15T14:30:00Z\"\n}"},{"id":"f80f94d0-8105-43ce-90f6-1e20255733cf","name":"No Active Enrollment","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer_id\": 9999,\n \"new_checklist_code\": \"Mobile Caregiver\",\n \"sync\": true\n}"},"url":"https://api.psbi.com/api/v1/partners/autopilot/transition"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"NO_ACTIVE_ENROLLMENT\",\n \"message\": \"Consumer has no active enrollment to transition from\"\n }\n}"}],"_postman_id":"936d8436-e676-40f7-8dbc-ba1d9e8656bf"},{"name":"Transition by Consumer Matching","event":[{"listen":"test","script":{"exec":["pm.test(\"Transition request accepted\", function () {"," pm.expect([200, 202, 400, 404]).to.include(pm.response.code);","});"],"type":"text/javascript","id":"4dd718bb-f549-4c9c-9257-5e173c8d7464"}}],"id":"624d527c-8943-499d-9498-e02e16aea68c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"ssn\": \"123456789\"\n },\n \"new_checklist_id\": 11,\n \"external_id\": \"TRANSITION-SSN-108\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://api.psbi.com/api/v1/partners/autopilot/transition","description":"

Transition a consumer by matching their identity.

Consumer Matching

When you don't have the consumer ID, provide matching data:

Match by SSN (Recommended)

{\n  \"consumer\": { \"ssn\": \"123456789\" },\n  \"new_checklist_code\": \"New Position\"\n}\n

Match by Email + Last Name

{\n  \"consumer\": {\n    \"email\": \"john.doe@example.com\",\n    \"last_name\": \"Doe\"\n  },\n  \"new_checklist_code\": \"New Position\"\n}\n

Match Priority

SSN - Exact match within your account
Email + Last Name - Combination match

Transition consumers between compliance positions.

\n","_postman_id":"82d69c84-b6da-4e7f-a453-2bf3894ae893"},{"name":"Status","item":[{"name":"Get Enrollment Status","event":[{"listen":"test","script":{"exec":["pm.test(\"Status retrieved\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});","","if (pm.response.code === 200) {"," pm.test(\"Has transaction details\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData).to.have.property('transaction');"," });","}"],"type":"text/javascript","id":"4377a665-a6bc-494e-a601-ca71844cadd5"}}],"id":"4bd92f84-e776-47ff-864a-76efd004fd69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","description":"

Your API Key

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/autopilot/enrollment/","description":"

Retrieve the status of an enrollment or transition.

URL Parameter

external_id: Your external ID from enrollment/transition

Status Values

received: Request received and queued
processing: Currently processing
processed: Successfully completed
failed: Processing failed

Response Fields

transaction.status: Current status
transaction.enrollment: Enrollment details (if processed)
transaction.consumer_transaction: Background check details (if created)

\n","urlObject":{"path":["api","v1","partners","autopilot","enrollment",""],"host":["https://api.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"107be1cc-6ca4-427b-8cea-44c4c86b5937","name":"Status Retrieved","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/autopilot/enrollment/HR-2025-001234"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction\": {\n \"id\": 1234,\n \"external_id\": \"HR-2025-001234\",\n \"status\": \"processed\",\n \"transaction_type\": \"autopilot_enroll\",\n \"received_at\": \"2025-01-15T10:30:00Z\",\n \"processed_at\": \"2025-01-15T10:30:45Z\",\n \"enrollment\": {\n \"id\": 108,\n \"checklist_name\": \"Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2025-01-15T10:30:00Z\"\n },\n \"consumer_transaction\": {\n \"id\": 5678,\n \"status\": \"processing\",\n \"search_count\": 5,\n \"consumer\": {\n \"id\": 1461,\n \"name\": \"John Doe\"\n }\n }\n }\n}"},{"id":"981ca482-14a0-45df-b140-06a0d86ae4d3","name":"Enrollment Not Found","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://api.psbi.com/api/v1/partners/autopilot/enrollment/INVALID-ID"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"ENROLLMENT_NOT_FOUND\",\n \"message\": \"Enrollment not found\"\n }\n}"}],"_postman_id":"4bd92f84-e776-47ff-864a-76efd004fd69"}],"id":"f82a340f-0d0e-4c94-a1b8-e5e27c1abd37","description":"

Check status of enrollment and transition requests.

\n","_postman_id":"f82a340f-0d0e-4c94-a1b8-e5e27c1abd37"}],"id":"9d4d9f03-a9fe-4d58-aea2-ad9c4b310127","description":"

AutoPilot API

The AutoPilot API enables automated consumer enrollment and position management for compliance tracking.

Key Concepts

Checklists (Positions)

A checklist defines compliance requirements for a position (e.g., \"Caregiver\", \"Driver\").

Enrollment Paths

email_onboarding: Consumer receives onboarding email
email_consent: Consumer receives consent-only email
instant: Process immediately with client task
manual_entry: Create task for staff
enroll_only: Create enrollment without transaction

Transitions

Move consumers between positions with smart differential analysis:

Reuses valid existing compliance
Only runs checks for net-new requirements

Workflow

Enroll Consumer - Assign to position
Background Check - Runs based on enrollment path
Transition (optional) - Move to new position

\n","_postman_id":"9d4d9f03-a9fe-4d58-aea2-ad9c4b310127"},{"name":"Webhooks (Reference)","item":[{"name":"Example: Transaction Review Webhook","id":"5f82bce1-2752-487b-8e02-6d709e9740af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-PSBI-Signature","value":"sha256=webhook-signature-here","description":"

HMAC signature

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event\": \"transaction.review\",\n \"timestamp\": \"2025-01-18T10:15:22Z\",\n \"webhook_id\": \"wh_abc123def456\",\n \"transaction\": {\n \"id\": \"PTX-12345\",\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"processing\"\n },\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"review\",\n \"completion_percentage\": 75\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/psbi/webhooks","description":"

Example webhook payload sent TO your endpoint.

PSBI sends webhooks to notify you of transaction progress.

Webhook Events

transaction.review: Background check in review
transaction.complete: Background check completed

Webhook Security

Verify the X-PSBI-Signature header using HMAC-SHA256 with your shared secret.

Response Requirements

Return 2xx status to acknowledge
Respond within 30 seconds
Be idempotent (handle duplicates)

\n","urlObject":{"protocol":"https","path":["psbi","webhooks"],"host":["your-webhook-endpoint","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f82bce1-2752-487b-8e02-6d709e9740af"},{"name":"Example: Transaction Complete Webhook","id":"4d2a4a37-fda0-4e21-8542-ef1222fd97e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"X-PSBI-Signature","value":"sha256=webhook-signature-here","description":"

HMAC signature

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event\": \"transaction.complete\",\n \"timestamp\": \"2025-01-20T11:45:10Z\",\n \"webhook_id\": \"wh_def456ghi789\",\n \"transaction\": {\n \"id\": \"PTX-12345\",\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"completed\",\n \"completed_at\": \"2025-01-20T11:45:00Z\"\n },\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"complete\",\n \"final_total\": 42.50,\n \"report_url\": \"https://app.psbi.com/reports/view/abc123\"\n },\n \"results_summary\": {\n \"total_searches\": 4,\n \"clear_searches\": 3,\n \"flagged_searches\": 1\n },\n \"documents\": {\n \"total_count\": 2,\n \"completion_report_available\": true,\n \"documents_url\": \"https://api.psbi.com/api/v1/partners/transactions/CONSUMER_12345/documents\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-endpoint.com/psbi/webhooks","description":"

Example webhook payload sent TO your endpoint when a background check completes.

Additional Fields

Results Summary

total_searches: Total searches performed
clear_searches: No findings
flagged_searches: Has findings

Documents

completion_report_available: Final report ready
documents_url: API endpoint to download documents

Webhook Reference

These are examples of webhooks PSBI sends to YOUR endpoint, not endpoints you call.

Configure your webhook URL with your implementation team to receive these notifications.

\n","_postman_id":"0c92d22a-34b6-46d3-9644-646461b9c410"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["pm.globals.set('current_timestamp', new Date().toISOString());"],"id":"d260700b-2772-463b-9393-234fd0eb5400"}},{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response time is acceptable\", function () {"," pm.expect(pm.response.responseTime).to.be.below(30000);","});","","pm.test(\"Response has JSON content type\", function () {"," var contentType = pm.response.headers.get('Content-Type');"," if (contentType) {"," pm.expect(contentType).to.include('application/json');"," }","});"],"id":"52e7860b-ac6f-4d9e-8892-7fed42b6bd11"}}],"variable":[{"key":"base_url","value":"https://api.psbi.com","type":"string","description":"Base URL for the PSBI Partner API. Change to http://localhost:8000 for local testing."},{"key":"api_key","value":"your-api-key-here","type":"string","description":"Your API Key provided by the PSBI implementation team"},{"key":"last_gateway_external_id","value":"","type":"string","description":"Last external ID from Partner Gateway transactions"},{"key":"last_autopilot_external_id","value":"","type":"string","description":"Last external ID from AutoPilot enrollments"},{"key":"last_consumer_id","value":"","type":"string","description":"Last consumer ID for transition testing"},{"key":"last_transition_id","value":"","type":"string","description":"Last transition external ID"},{"key":"first_document_id","value":"","type":"string","description":"First document ID for download testing"}]}