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

PSBI Partner API

Build background screening and ongoing compliance into your HRIS, ATS or workforce platform.

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

Part	What it does
AutoPilot API	Enroll a person into a position (a checklist). PSBI orders everything that position requires and keeps it current.
Partner Gateway	Order specific background check products for a person.
Status Webhooks	PSBI posts to your endpoint when an order is in review, in progress and complete.

New integration? Start with Recipe: AutoPilot enrollment with status webhooks. It walks through a working integration from the first API call to the completed report.

Using an AI assistant or coding agent? Point it at the plain-markdown version: psbi.com/developers/partner-api.md, with the recipe at psbi.com/developers/autopilot-webhooks-recipe.md. Both are indexed from psbi.com/llms.txt.

Base URL

https://app.psbi.com\n

Authentication

Every request carries your API key. Send it in a header:

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

Authorization: Bearer your-api-key is also accepted.

A key belongs to one connection, and a connection belongs to one PSBI client account. Every request acts on that account only.
Keep keys server-side. A key is a credential for your clients' screening data.
If the system calling PSBI cannot set headers, an api_key query parameter is accepted. Prefer a header wherever you can, because URLs end up in logs.

Your PSBI implementation contact issues keys.

Requests

Send JSON with Content-Type: application/json, and Accept: application/json.
Dates are YYYY-MM-DD. Timestamps in responses are ISO 8601 in UTC.

Responses

Every response has a boolean success. Failures add an error object:

{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"VALIDATION_FAILED\",\n    \"message\": \"The provided data is invalid\",\n    \"details\": { \"consumer.email\": [\"Consumer email is required\"] }\n  }\n}\n

details is included when there is more to say.

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP	`error.code`	Meaning
400	`NO_CLIENT_ASSOCIATION`	The API key is not attached to a client account. Contact PSBI.
401	`MISSING_API_KEY`	No API key was sent.
401	`INVALID_API_KEY`	The key is wrong or has been deactivated.
404	`TRANSACTION_NOT_FOUND`	No request with that `external_id` exists on your connection.
404	`CHECKLIST_NOT_FOUND`	The checklist does not exist, is inactive, or belongs to another account.
404	`CONSUMER_NOT_FOUND`	A transition could not match the person.
404	`NO_ACTIVE_ENROLLMENT`	A transition found the person, but they are not enrolled in a position.
409	`DUPLICATE_TRANSACTION`	That `external_id` has already been used on your connection.
422	`VALIDATION_FAILED`	The body failed validation. `details` lists each field.
422	varies	A synchronous (`\"sync\": true`) request was valid but could not be processed, for example `already_enrolled`. Read `error.message`.
500	`INTERNAL_ERROR`	Something failed on PSBI's side. Retry later, and contact PSBI if it persists.

Identifiers

\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	Whose	Notes
`external_id`	Yours	Your reference for the request, such as a hire or requisition id. It must be unique per connection, and reusing one returns `409`. You look requests up by it, and it comes back on every status webhook. If you leave it out, PSBI generates one and returns it, but you should always send your own.
`transaction_id`	PSBI	The id of your API request in PSBI.
`consumer_transaction_id`	PSBI	The id of the background check order the request produced.
`consumer.id`	PSBI	The person's id in PSBI. Use it for transitions.

Synchronous and asynchronous processing

Asynchronous (default). PSBI validates the request, returns 202 Accepted with status: \"received\", and processes it in the background. Processing normally completes within a minute. Poll the status endpoint or wait for webhooks.
Synchronous (\"sync\": true). PSBI processes the request before responding and returns 200 with the result. Allow up to 30 seconds. This suits interactive screens. For bulk loads, use asynchronous.

Validation errors, unknown checklists and duplicate external_ids are rejected immediately in both modes.

Volume

There is no published per-minute limit. Before loading records in bulk (thousands at once), tell your implementation contact.

Support

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":{"type":"text/javascript","exec":["pm.test(\"API key accepted\", function () {"," pm.expect(pm.response.code).to.equal(404);"," pm.expect(pm.response.json().error.code).to.equal('TRANSACTION_NOT_FOUND');","});"]}}],"id":"6467233d-e31f-4763-94fa-83c275acb280","request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

Confirm your API key works before sending real requests.

This looks up a request id that does not exist, so a working key returns 404 TRANSACTION_NOT_FOUND. That 404 means you are authenticated.

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

Response	Meaning
`404 TRANSACTION_NOT_FOUND`	The key is valid.
`401 INVALID_API_KEY`	The key is wrong or inactive.
`401 MISSING_API_KEY`	No key reached PSBI. Check the header name.

","urlObject":{"path":["api","v1","partners","transactions","test-auth-check"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"eda24081-8787-4c00-99dc-9c857e7f102b","name":"Key is valid","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.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":"15aef297-bf6a-4fd3-a316-6d9a39723ba5","name":"Key is invalid","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.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}"},{"id":"234a2b5e-7d3d-4bb3-be8d-afa271ef9737","name":"Key is missing","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.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\": \"MISSING_API_KEY\",\n \"message\": \"API key is required. Provide via X-API-Key header or Authorization: Bearer token\"\n }\n}"}],"_postman_id":"6467233d-e31f-4763-94fa-83c275acb280"}],"id":"b331d066-61eb-4378-a3f0-5215c29a4c9c","description":"

Check your API key before sending real requests.

\n","_postman_id":"b331d066-61eb-4378-a3f0-5215c29a4c9c"},{"name":"Recipe: AutoPilot enrollment with status webhooks","item":[{"name":"Step 1: Verify your API key","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"API key accepted\", function () {"," pm.expect(pm.response.code).to.equal(404);"," pm.expect(pm.response.json().error.code).to.equal('TRANSACTION_NOT_FOUND');","});"]}}],"id":"48c13281-40b9-4812-a3ab-436ee5a881bd","request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

A working key returns 404 TRANSACTION_NOT_FOUND. Any 401 means the key or header is wrong.

\n","urlObject":{"path":["api","v1","partners","transactions","test-auth-check"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"48c13281-40b9-4812-a3ab-436ee5a881bd"},{"name":"Step 2: Enroll the new hire","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Enrollment accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);"," pm.expect(pm.response.json().success).to.be.true;","});","","var json = pm.response.json();","if (json.external_id) { pm.collectionVariables.set('last_autopilot_external_id', json.external_id); }","if (json.consumer && json.consumer.id) { pm.collectionVariables.set('last_consumer_id', json.consumer.id); }"]}}],"id":"f6e9b7db-12f5-48a0-9aa8-d435fc40085f","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

Enroll into the position on the email_onboarding path. The person receives an invitation, and the order is submitted once they finish it.

Set external_id to something that leads back to your record. The test script saves it for Step 3.

Every field and path is documented under AutoPilot API → Enroll Consumer.

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"fb2edd52-cae6-4780-ab15-f2cb2e3763fe","name":"Accepted (async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.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\": \"HR-2026-001234\",\n \"status\": \"received\",\n \"message\": \"Enrollment request received and queued for processing\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\"\n}"}],"_postman_id":"f6e9b7db-12f5-48a0-9aa8-d435fc40085f"},{"name":"Step 3: Check the enrollment","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status retrieved\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});"]}}],"id":"0e5a6b7d-114e-494e-9a70-ceb4008c2065","request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

Confirms the request was processed and an order exists. A failed request carries error_message.

\n","urlObject":{"path":["api","v1","partners","autopilot","enrollment",""],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"6ef0cbe3-bc1f-412e-807d-3093d97c25d3","name":"Processed","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/autopilot/enrollment/HR-2026-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-2026-001234\",\n \"type\": \"autopilot_enroll\",\n \"status\": \"processed\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"processed_at\": \"2026-09-15T14:02:43.000000Z\",\n \"error_message\": null\n },\n \"enrollment\": {\n \"id\": 108,\n \"consumer_id\": 54321,\n \"consumer_created\": true,\n \"search_count\": 0,\n \"pending_requirements\": true\n },\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"draft\",\n \"submitted_at\": null,\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\"\n }\n }\n}"},{"id":"61ec306b-eb3e-40a0-b97d-b4b9c068a7bf","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/autopilot/enrollment/HR-2026-001299"},"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\": 1299,\n \"external_id\": \"HR-2026-001299\",\n \"type\": \"autopilot_enroll\",\n \"status\": \"failed\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"processed_at\": \"2026-09-15T14:02:43.000000Z\",\n \"error_message\": \"Enrollment created but transaction failed: No requirements found for this checklist\"\n }\n}"}],"_postman_id":"0e5a6b7d-114e-494e-9a70-ceb4008c2065"}],"id":"f05112c2-2ca9-48cf-8305-963549f7a577","description":"

Recipe: AutoPilot enrollment with status webhooks

Enroll a new hire into their position and keep your system updated as their background check moves from review to in progress to complete, all without polling.

You'll need: an API key, the checklist (position) names or ids for your client, and an HTTPS endpoint that can receive webhooks.

How it fits together

Your system                          PSBI\n───────────                          ────\nPOST /autopilot/enroll ───────────▶  202 Accepted (status: received)\n                                     person is matched or created, enrolled, order created\n                                     person completes the email invitation\n            ◀─────────── webhook     review       information collected, awaiting submission\n            ◀─────────── webhook     in_progress  searches running\n            ◀─────────── webhook     complete     result: clear | needs_review\n            ◀─────────── webhook     complete     report_url: the PDF is ready\n

1. Get set up with PSBI

Your implementation contact provides:

an API key for the client account;
the checklists you will enroll into, with their exact names or ids, such as Caregiver and Driver;
a signing secret, once you've sent them your webhook URL.

Decide on an external_id scheme. It should be unique per request and should lead back to your record, for example <your record id>-<attempt>. Every webhook carries it back to you.

2. Verify your key

Run Step 1: Verify your API key. A 404 TRANSACTION_NOT_FOUND means the key works.

3. Build the webhook receiver first

Build it before you enroll anyone, so the first events aren't missed. Your endpoint should:

Verify X-P51-Signature. It is an HMAC-SHA256 of the raw body with your signing secret, and Status Webhooks has code for it.
Return 2xx quickly, within 30 seconds. Queue the work.
Look the record up by external_id.
Apply the update idempotently. Retries can repeat an event, and order isn't guaranteed.

4. Enroll

Run Step 2: Enroll the new hire. The request is asynchronous and returns 202 with your external_id:

{\n  \"success\": true,\n  \"transaction_id\": 1234,\n  \"external_id\": \"HR-2026-001234\",\n  \"status\": \"received\",\n  \"message\": \"Enrollment request received and queued for processing\",\n  \"received_at\": \"2026-09-15T14:02:11.000000Z\"\n}\n

Store the mapping from external_id to your record. If you get 409 DUPLICATE_TRANSACTION, that external_id is already in use; don't reuse ids across attempts.

5. Confirm it processed (optional)

Run Step 3: Check the enrollment about a minute later.

transaction.status: \"processed\" with a consumer_transaction. An order exists and webhooks will follow.
transaction.status: \"failed\". error_message says why. Fix the problem and enroll again with a new external_id.

6. Handle the status webhooks

\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

`status`	`result`	Suggested state in your system
`review`		Awaiting submission
`in_progress`		Screening in progress
`complete`	`clear`	Screening complete: clear
`complete`	`needs_review`	Screening complete: client review needed

On consumer.transaction.report_generated, download report_url and attach the PDF to the person's record.

Two things to know:

review happens before searches run. It means the order is ready to submit. The outcome of the searches only arrives on complete.
needs_review is not a decision. It means a person at the client needs to look at a result in PSBI. Any adverse action runs through PSBI's FCRA workflow, not through the API.

7. Test it end to end

Point the webhook URL at a request inspector, such as webhook.site, or your staging receiver.
Enroll a test person with your own email address on the email_onboarding path.
Complete the invitation email. You should receive review, then in progress.
Your implementation contact can take a test order through to complete and report ready.
Check signature verification against the real deliveries, not just the examples here.

Going live checklist

Production API key stored server-side.
Webhook URL registered, and signing secret stored.
Signature verified on every request, and mismatches rejected.
Receiver acknowledges within 30 seconds and tolerates duplicates.
external_id is unique per request.
Reports downloaded from report_url and stored securely.
Failed enrollments surfaced to a person (step 5).

\n","_postman_id":"f05112c2-2ca9-48cf-8305-963549f7a577"},{"name":"AutoPilot API","item":[{"name":"Enrollment","item":[{"name":"Enroll Consumer (Minimal)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Enrollment accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);"," pm.expect(pm.response.json().success).to.be.true;","});","","var json = pm.response.json();","if (json.external_id) { pm.collectionVariables.set('last_autopilot_external_id', json.external_id); }","if (json.consumer && json.consumer.id) { pm.collectionVariables.set('last_consumer_id', json.consumer.id); }"]}}],"id":"53ed660d-7e96-4567-9313-dd43ab8def33","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

Enroll a person into a position with only the required fields.

Defaults that apply here:

Path: the account default, normally email_onboarding, so the person receives an email invitation.
Processing: asynchronous. You get 202 Accepted straight away.
Order: created, then submitted once the person completes their invitation.

Save the external_id. It is how you look the request up and how status webhooks refer to it.

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\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\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	Type	Required	Description
`external_id`	string (max 255)	Recommended	Your reference for this request. Unique per connection.
`consumer.first_name`	string	Yes
`consumer.last_name`	string	Yes
`consumer.email`	string	Yes	Where the person's invitation goes on email paths.
`consumer.phone`	string	No
`consumer.ssn`	string	No	9 digits. Used to match an existing person.
`consumer.date_of_birth`	date	No	`YYYY-MM-DD`
`consumer.address`, `consumer.city`, `consumer.state`, `consumer.zip`	string	No	`state` is the two-letter code.
`checklist_id`	integer	One of	The position to enroll into.
`checklist_code`	string	One of	The position's exact name, as an alternative to `checklist_id`.
`tag_ids` / `tag_codes`	array	No	Additional requirement tags, by id or exact name. Unknown tags are ignored.
`enrollment_path`	string	No	How the person is onboarded. See the table below.
`create_initial_transaction`	boolean	No	Overrides whether an order is created. By default one is created on every path except `enroll_only`.
`sync`	boolean	No	Process before responding. Default `false`.
`user_email`	string	No	On synchronous requests, the email of the client user to attribute the order to.
`metadata`	object	No	Your own key/value data, stored on the order.
`notes`	string (max 2000)	No	Stored with the request.

Enrollment paths

\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

`enrollment_path`	What happens
`email_onboarding`	The person gets an email invitation to fill in their details and give consent. The order is submitted once they finish.
`email_consent`	Same invitation flow as `email_onboarding`.
`instant` / `manual_entry`	No email to the person. A task is created for the client's team to complete the person's details in PSBI.
`enroll_only`	Enrolls the person in the position without ordering anything. No email, no order, no status webhooks.

If you leave enrollment_path out, the account's default is used, which is email_onboarding unless PSBI has configured another.

Matching an existing person

PSBI looks for the person in your account before creating a new record:

SSN. An exact match, when consumer.ssn is sent.
Email plus last name.
Otherwise a new person is created.

On a synchronous response, consumer.created tells you which happened.

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"dc07e60a-c47f-404a-b846-550ad4efe329","name":"Accepted (async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2026-001234\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"checklist_code\": \"Caregiver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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\": \"HR-2026-001234\",\n \"status\": \"received\",\n \"message\": \"Enrollment request received and queued for processing\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\"\n}"}],"_postman_id":"53ed660d-7e96-4567-9313-dd43ab8def33"},{"name":"Enroll Consumer (Full, Sync)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Enrollment accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);"," pm.expect(pm.response.json().success).to.be.true;","});","","var json = pm.response.json();","if (json.external_id) { pm.collectionVariables.set('last_autopilot_external_id', json.external_id); }","if (json.consumer && json.consumer.id) { pm.collectionVariables.set('last_consumer_id', json.consumer.id); }"]}}],"id":"a3153b79-cd3d-41e5-abd5-3676baafbb6c","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-1789977182\",\n \"consumer\": {\n \"first_name\": \"Ethelyn\",\n \"last_name\": \"Blanda\",\n \"email\": \"Felix_Upton68@gmail.com\",\n \"phone\": \"555-123-4567\",\n \"ssn\": \"123456789\",\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\": \"email_onboarding\",\n \"user_email\": \"hiring.manager@example.com\",\n \"sync\": true,\n \"metadata\": {\n \"department\": \"Nursing\",\n \"hire_date\": \"2026-10-01\"\n },\n \"notes\": \"New hire for ICU\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/enroll","description":"

Enroll with every option set, processed synchronously so the response carries the result.

Response fields (sync)

\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
`transaction_id`	PSBI's id for this API request.
`enrollment`	The position enrollment: `id`, `checklist_name`, `status`, `enrolled_at`.
`consumer`	The person: `id`, `name`, `email`, and `created` (`true` if PSBI created a new record, `false` if it matched an existing one).
`transaction`	The background check order: `id` (the `consumer_transaction_id` on webhooks), `status`, `search_count`. Absent when no order was created.
`task`	The onboarding task created, if any: `id`, `type`.
`pending_requirements`	Present and `true` when the position still has requirements that aren't satisfied yet.

On email paths the order starts in draft with search_count 0. Searches are added when the person completes their invitation.

Synchronous failures

A valid request that cannot be processed returns 422. error.code names the reason, for example already_enrolled when the person is already active in this position. The external_id is spent either way, so resend with a new one.

Request fields

Field	Type	Required	Description
`external_id`	string (max 255)	Recommended	Your reference for this request. Unique per connection.
`consumer.first_name`	string	Yes
`consumer.last_name`	string	Yes
`consumer.email`	string	Yes	Where the person's invitation goes on email paths.
`consumer.phone`	string	No
`consumer.ssn`	string	No	9 digits. Used to match an existing person.
`consumer.date_of_birth`	date	No	`YYYY-MM-DD`
`consumer.address`, `consumer.city`, `consumer.state`, `consumer.zip`	string	No	`state` is the two-letter code.
`checklist_id`	integer	One of	The position to enroll into.
`checklist_code`	string	One of	The position's exact name, as an alternative to `checklist_id`.
`tag_ids` / `tag_codes`	array	No	Additional requirement tags, by id or exact name. Unknown tags are ignored.
`enrollment_path`	string	No	How the person is onboarded. See the table below.
`create_initial_transaction`	boolean	No	Overrides whether an order is created. By default one is created on every path except `enroll_only`.
`sync`	boolean	No	Process before responding. Default `false`.
`user_email`	string	No	On synchronous requests, the email of the client user to attribute the order to.
`metadata`	object	No	Your own key/value data, stored on the order.
`notes`	string (max 2000)	No	Stored with the request.

Enrollment paths

\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

`enrollment_path`	What happens
`email_onboarding`	The person gets an email invitation to fill in their details and give consent. The order is submitted once they finish.
`email_consent`	Same invitation flow as `email_onboarding`.
`instant` / `manual_entry`	No email to the person. A task is created for the client's team to complete the person's details in PSBI.
`enroll_only`	Enrolls the person in the position without ordering anything. No email, no order, no status webhooks.

If you leave enrollment_path out, the account's default is used, which is email_onboarding unless PSBI has configured another.

Matching an existing person

PSBI looks for the person in your account before creating a new record:

SSN. An exact match, when consumer.ssn is sent.
Email plus last name.
Otherwise a new person is created.

On a synchronous response, consumer.created tells you which happened.

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"3c113d0f-d8c1-45e3-8b7b-0fcf459b3d25","name":"Processed (sync)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2026-001234\",\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-05-15\",\n \"address\": \"123 Main Street\",\n \"city\": \"Austin\",\n \"state\": \"TX\",\n \"zip\": \"78701\"\n },\n \"checklist_code\": \"Caregiver\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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-2026-001234\",\n \"status\": \"processed\",\n \"message\": \"Consumer onboarding task created. Transaction will be created after task completion.\",\n \"enrollment\": {\n \"id\": 108,\n \"checklist_name\": \"Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2026-09-15T14:02:11.000000Z\"\n },\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"created\": true\n },\n \"transaction\": {\n \"id\": 98765,\n \"status\": \"draft\",\n \"search_count\": 0\n },\n \"task\": {\n \"id\": 9012,\n \"type\": \"Consumer Onboarding\"\n },\n \"pending_requirements\": true\n}"},{"id":"57541f86-7586-4425-90da-efd8deeee5f3","name":"Validation error","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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\": [\n \"Consumer last name is required\"\n ],\n \"consumer.email\": [\n \"Consumer email is required\"\n ],\n \"checklist_id\": [\n \"Either checklist_id or checklist_code is required\"\n ],\n \"checklist_code\": [\n \"Either checklist_id or checklist_code is required\"\n ]\n }\n }\n}"},{"id":"884e4fae-b454-4e05-ad07-72e3c2576b67","name":"Checklist not found","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","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}","options":{"raw":{"language":"json"}}},"url":"https://app.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 or not available\",\n \"details\": {\n \"identifier\": \"Invalid Position\"\n }\n }\n}"},{"id":"198c67bc-f123-4e9d-ab18-ee590fba9999","name":"Duplicate external_id","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2026-001234\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"checklist_code\": \"Caregiver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/enroll"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"DUPLICATE_TRANSACTION\",\n \"message\": \"Transaction with this external ID already exists\",\n \"details\": {\n \"external_id\": \"HR-2026-001234\",\n \"existing_transaction_id\": 1234\n }\n }\n}"},{"id":"d71a9bb7-fea7-4812-ad81-a7e16cf355b7","name":"Already enrolled (sync)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"HR-2026-001235\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"checklist_code\": \"Caregiver\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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 \"transaction_id\": 1235,\n \"external_id\": \"HR-2026-001235\",\n \"error\": {\n \"code\": \"already_enrolled\",\n \"message\": \"Consumer is already enrolled in Caregiver\"\n }\n}"}],"_postman_id":"a3153b79-cd3d-41e5-abd5-3676baafbb6c"},{"name":"Enroll Consumer (Enroll Only)","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Enrollment accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);"," pm.expect(pm.response.json().success).to.be.true;","});","","var json = pm.response.json();","if (json.external_id) { pm.collectionVariables.set('last_autopilot_external_id', json.external_id); }","if (json.consumer && json.consumer.id) { pm.collectionVariables.set('last_consumer_id', json.consumer.id); }"]}}],"id":"7dbe619f-3ca7-44d2-aaea-2c8ad8f6e375","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

Put a person in a position without ordering anything.

Use this to load existing employees whose screening is already on file, or to start tracking a position before a background check is due.

An enrollment is created, and the position's requirements show as outstanding (pending_requirements: true).
No order is created and no email is sent, so no status webhooks follow.
The response has no transaction or task.

\n","urlObject":{"path":["api","v1","partners","autopilot","enroll"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"0ce2c55f-dde4-47cc-b1d8-08960b6c8af6","name":"Enrolled without an order","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","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}","options":{"raw":{"language":"json"}}},"url":"https://app.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 \"message\": \"Successfully enrolled Jane Smith in Caregiver (no initial transaction)\",\n \"enrollment\": {\n \"id\": 109,\n \"checklist_name\": \"Caregiver\",\n \"status\": \"active\",\n \"enrolled_at\": \"2026-09-15T14:02:11.000000Z\"\n },\n \"consumer\": {\n \"id\": 54322,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@example.com\",\n \"created\": true\n },\n \"pending_requirements\": true\n}"}],"_postman_id":"7dbe619f-3ca7-44d2-aaea-2c8ad8f6e375"}],"id":"496a4984-2ce7-4f9b-be1d-7b4210b18286","description":"

Put people into positions.

\n","_postman_id":"496a4984-2ce7-4f9b-be1d-7b4210b18286"},{"name":"Transition","item":[{"name":"Transition by Consumer ID","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Transition handled\", function () {"," pm.expect([200, 202, 404]).to.include(pm.response.code);","});","if (pm.response.json().external_id) { pm.collectionVariables.set('last_transition_id', pm.response.json().external_id); }"]}}],"id":"e26b042d-94a3-4ce0-820e-bb4da8dca7dd","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

Move a person to a new position, identified by PSBI's consumer_id.

What a transition does

Finds the person's active position enrollment.
Compares the new position's requirements with what the person already has.
Carries over compliance that is still valid (reused_count).
Orders only what is new (net_new_count). If nothing is new, no order is created and no status webhooks follow.
Replaces the old enrollment with the new one.

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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`consumer_id`	integer	One of	PSBI's id for the person.
`consumer`	object	One of	Matching data: `ssn`, or `email` and `last_name`.
`new_checklist_id` / `new_checklist_code`	integer / string	One of	The new position.
`external_id`	string	Recommended	Your reference for this request. Unique per connection.
`sync`	boolean	No	Process before responding.
`metadata`	object	No	Your own key/value data.
`notes`	string	No

Tags are not accepted on transitions.

Whether or not you send sync, an unknown person (CONSUMER_NOT_FOUND) or position (CHECKLIST_NOT_FOUND) is rejected immediately.

\n","urlObject":{"path":["api","v1","partners","autopilot","transition"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"3c0ebe98-2da3-46f6-911c-c9aa0b554d03","name":"Transitioned (sync)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer_id\": 54321,\n \"new_checklist_code\": \"Mobile Caregiver\",\n \"external_id\": \"TRANSITION-001234\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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 \"message\": \"Position transition created with 2 new requirements (3 reused)\",\n \"enrollment\": {\n \"id\": 110,\n \"checklist_name\": \"Mobile Caregiver\",\n \"status\": \"active\"\n },\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\"\n },\n \"analysis\": {\n \"reused_count\": 3,\n \"net_new_count\": 2\n },\n \"transaction\": {\n \"id\": 98770,\n \"status\": \"draft\",\n \"search_count\": 0\n }\n}"},{"id":"e255dae9-d283-491f-8dbe-c9278f7e55b0","name":"No active enrollment","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer_id\": 54321,\n \"new_checklist_code\": \"Mobile Caregiver\",\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/transition"},"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\": \"NO_ACTIVE_ENROLLMENT\",\n \"message\": \"Consumer has no active AutoPilot enrollment\",\n \"details\": {\n \"consumer_id\": 54321\n }\n }\n}"}],"_postman_id":"e26b042d-94a3-4ce0-820e-bb4da8dca7dd"},{"name":"Transition by Consumer Matching","id":"65b114dc-f868-4914-a368-441d2761b2f2","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","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-1789977182\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/transition","description":"

Move a person to a new position when you don't have PSBI's consumer_id.

Match on SSN (preferred):

{ \"consumer\": { \"ssn\": \"123456789\" }, \"new_checklist_code\": \"Mobile Caregiver\" }\n

Or on email and last name together (email alone never matches):

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

What a transition does

Finds the person's active position enrollment.
Compares the new position's requirements with what the person already has.
Carries over compliance that is still valid (reused_count).
Orders only what is new (net_new_count). If nothing is new, no order is created and no status webhooks follow.
Replaces the old enrollment with the new one.

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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`consumer_id`	integer	One of	PSBI's id for the person.
`consumer`	object	One of	Matching data: `ssn`, or `email` and `last_name`.
`new_checklist_id` / `new_checklist_code`	integer / string	One of	The new position.
`external_id`	string	Recommended	Your reference for this request. Unique per connection.
`sync`	boolean	No	Process before responding.
`metadata`	object	No	Your own key/value data.
`notes`	string	No

Tags are not accepted on transitions.

Whether or not you send sync, an unknown person (CONSUMER_NOT_FOUND) or position (CHECKLIST_NOT_FOUND) is rejected immediately.

\n","urlObject":{"path":["api","v1","partners","autopilot","transition"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"cb89c5a5-23a3-495e-9216-478858b77b76","name":"Accepted (async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"ssn\": \"123456789\"\n },\n \"new_checklist_id\": 11,\n \"external_id\": \"TRANSITION-SSN-001234\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/transition"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 1238,\n \"external_id\": \"TRANSITION-SSN-001234\",\n \"status\": \"received\",\n \"message\": \"Transition request received and queued for processing\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\"\n}"},{"id":"b067214c-c7b5-4e5a-93a0-1d2f1461b849","name":"Consumer not found","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"email\": \"unknown@example.com\",\n \"last_name\": \"Unknown\"\n },\n \"new_checklist_code\": \"Mobile Caregiver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/autopilot/transition"},"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\": \"CONSUMER_NOT_FOUND\",\n \"message\": \"Consumer not found\",\n \"details\": {\n \"identifiers\": [\n \"email\",\n \"last_name\"\n ]\n }\n }\n}"}],"_postman_id":"65b114dc-f868-4914-a368-441d2761b2f2"}],"id":"fe9f7baf-93e5-4213-9b00-eeb2443460a5","description":"

Move people between positions.

\n","_postman_id":"fe9f7baf-93e5-4213-9b00-eeb2443460a5"},{"name":"Status","item":[{"name":"Get Enrollment Status","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status retrieved\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});"]}}],"id":"4c91edbf-d412-434d-9671-e7c6852af771","request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

Look up an enroll or transition request by your external_id.

Response

\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
`transaction.status`	Processing of your request: `received`, then `processing`, then `processed` or `failed`.
`transaction.error_message`	Why a request `failed`.
`transaction.type`	`autopilot_enroll` or `autopilot_transition`.
`enrollment`	Present once the request is processed: `id`, `consumer_id`, `consumer_created`, `search_count`, `pending_requirements`.
`transition_analysis`	Transitions only: `reused_count`, `net_new_count`.
`consumer_transaction`	The background check order, if one was created: `id`, `status`, `submitted_at`, `consumer`.

consumer_transaction.status is the order's own status:

\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

Order status	Meaning
`draft`	Waiting on the person's invitation or the client's task.
`review`	Information collected, waiting for the order to be submitted.
`processing`	Submitted; searches are in progress.
`complete`	Every search is finished.
`cancelled`	Cancelled.

A request that was processed without a consumer_transaction either created no order (enroll_only, or a transition with nothing new) or found the person already active in that position.

You don't need to poll this endpoint once status webhooks are set up. It is useful for confirming a request was processed, and for reconciling after an outage.

\n","urlObject":{"path":["api","v1","partners","autopilot","enrollment",""],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"a41360b3-64ce-46f5-bf2b-eba3db2ab796","name":"Processed","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/autopilot/enrollment/HR-2026-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-2026-001234\",\n \"type\": \"autopilot_enroll\",\n \"status\": \"processed\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"processed_at\": \"2026-09-15T14:02:43.000000Z\",\n \"error_message\": null\n },\n \"enrollment\": {\n \"id\": 108,\n \"consumer_id\": 54321,\n \"consumer_created\": true,\n \"search_count\": 0,\n \"pending_requirements\": true\n },\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"draft\",\n \"submitted_at\": null,\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\"\n }\n }\n}"},{"id":"58e9d62e-3b0e-40fe-a506-7947e3796ac4","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/autopilot/enrollment/HR-2026-001299"},"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\": 1299,\n \"external_id\": \"HR-2026-001299\",\n \"type\": \"autopilot_enroll\",\n \"status\": \"failed\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"processed_at\": \"2026-09-15T14:02:43.000000Z\",\n \"error_message\": \"Enrollment created but transaction failed: No requirements found for this checklist\"\n }\n}"},{"id":"5a114ba5-e475-4eaa-bf9e-d3669e25cc08","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/autopilot/enrollment/UNKNOWN-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 \"details\": {\n \"external_id\": \"UNKNOWN-ID\"\n }\n }\n}"}],"_postman_id":"4c91edbf-d412-434d-9671-e7c6852af771"}],"id":"3dfd4786-b9a5-4435-b5d9-70c1d1c6e631","description":"

Check the outcome of enroll and transition requests.

\n","_postman_id":"3dfd4786-b9a5-4435-b5d9-70c1d1c6e631"}],"id":"9bb3eb6c-1cdf-4187-9270-c32b8fccdfdb","description":"

AutoPilot API

AutoPilot manages a person's compliance for a position. You say which position someone holds, and PSBI orders what that position requires, tracks when each requirement expires, and handles changes when the person moves to another position.

Concepts

Checklist (position). A named set of requirements, such as \"Caregiver\" or \"Driver\". Your PSBI implementation contact sets these up and gives you their ids or exact names.
Tags. Extra requirements layered onto a position, such as \"DOT\".
Enrollment. A person's membership in a position.
Order. The background check PSBI places to satisfy the requirements. This is what status webhooks report on.

Endpoints

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

Endpoint	Use
`POST /api/v1/partners/autopilot/enroll`	Put a person in a position.
`POST /api/v1/partners/autopilot/transition`	Move a person to a different position.
`GET /api/v1/partners/autopilot/enrollment/{external_id}`	Check a request's outcome.

Enrolling someone who is already enrolled

Asynchronous requests. If the person is already active in the same position, the request is marked processed with no new order. If they are active in a different position, the enroll is handled as a transition to the new one.
Synchronous requests. The same position is rejected with 422 already_enrolled.

\n","_postman_id":"9bb3eb6c-1cdf-4187-9270-c32b8fccdfdb"},{"name":"Partner Gateway","item":[{"name":"Create Consumer Transaction","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Transaction accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);"," pm.expect(pm.response.json().success).to.be.true;","});","if (pm.response.json().external_id) { pm.collectionVariables.set('last_gateway_external_id', pm.response.json().external_id); }"]}}],"id":"f03768f4-3503-4daa-a45f-8d75bbb93fa1","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_1789977182\",\n \"transaction_type\": \"consumer\",\n \"consumer\": {\n \"first_name\": \"Tyree\",\n \"last_name\": \"Gleason\",\n \"email\": \"Aylin.Walsh@hotmail.com\",\n \"phone\": \"555-123-4567\",\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 \"metadata\": {\n \"employee_id\": \"E-10442\",\n \"notes\": \"Pre-hire screening\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/transactions","description":"

Order background check products for a person, who receives an email invitation to complete their details and give consent.

transaction_type: \"consumer\" is the default. Processing is asynchronous unless you send \"sync\": true.

Status webhooks work the same for Gateway orders as for AutoPilot orders.

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\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	Type	Required	Description
`external_id`	string (max 255)	Recommended	Your reference. Unique per connection; reusing it returns `409`.
`transaction_type`	string	No	`consumer` (default) or `client`.
`consumer.first_name`, `consumer.last_name`	string	Yes
`consumer.email`	string	Yes
`consumer.phone`, `consumer.ssn`, `consumer.date_of_birth`	string / date	No
`consumer.address`, `consumer.city`, `consumer.state`, `consumer.zip`	string	No
`products`	array	Yes	At least one product. See below.
`metadata`	object	No	Your own key/value data, such as `employee_id` or `notes`.
`sync`	boolean	No	Process before responding. Default `false`.

Products

Each entry in products can be any of these:

a product name: \"County Criminal\"
a PSBI product id: 12
an object: { \"product_id\": 12 }, { \"product_name\": \"County Criminal\" }, { \"order_template_id\": 3 } or { \"order_template_name\": \"Standard Package\" }

Names are matched against your account's products, then its order templates (packages). If nothing matches, your account's default products are ordered rather than the request failing. Confirm the exact product and package names with your implementation contact before you go live.

\n","urlObject":{"path":["api","v1","partners","transactions"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"ff0fd735-6f32-4df9-af83-6a97bca68365","name":"Accepted (async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_12345\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"products\": [\n \"Statewide Criminal\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/transactions"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 5114,\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"received\",\n \"message\": \"Transaction received and queued for processing\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"estimated_completion\": \"2026-09-18T14:02:11.000000Z\",\n \"tracking_url\": null,\n \"consumer\": {\n \"id\": null,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n }\n}"},{"id":"babe810b-ab5b-4a06-b473-83ed1619ad90","name":"Processed (sync)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_12345\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"products\": [\n \"Statewide Criminal\"\n ],\n \"sync\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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\": 5114,\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"processed\",\n \"message\": \"Transaction processed successfully\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"estimated_completion\": \"2026-09-18T14:02:11.000000Z\",\n \"tracking_url\": null,\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\"\n }\n}"},{"id":"0820aba7-c145-4b9b-94b9-cc7cc905707f","name":"Validation error","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"consumer\": {\n \"first_name\": \"John\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://app.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\": [\n \"Consumer last name is required\"\n ],\n \"consumer.email\": [\n \"Consumer email is required\"\n ],\n \"products\": [\n \"At least one product or service is required\"\n ]\n }\n }\n}"},{"id":"38bbd9a7-d987-45e2-bec1-6398f099d87f","name":"Duplicate external_id","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CONSUMER_12345\",\n \"consumer\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\"\n },\n \"products\": [\n \"Statewide Criminal\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/transactions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"code\": \"DUPLICATE_TRANSACTION\",\n \"message\": \"This event has already been processed\",\n \"details\": {\n \"external_id\": \"CONSUMER_12345\",\n \"original_transaction_id\": 5114,\n \"original_status\": \"processed\"\n }\n }\n}"}],"_postman_id":"f03768f4-3503-4daa-a45f-8d75bbb93fa1"},{"name":"Create Client Transaction","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Transaction accepted\", function () {"," pm.expect([200, 202]).to.include(pm.response.code);","});","if (pm.response.json().external_id) { pm.collectionVariables.set('last_gateway_external_id', pm.response.json().external_id); }"]}}],"id":"c8dbbc52-ac52-46f3-a1d0-d2e0bf8e1189","request":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"CLIENT_1789977182\",\n \"transaction_type\": \"client\",\n \"consumer\": {\n \"first_name\": \"Jeffery\",\n \"last_name\": \"Padberg\",\n \"email\": \"Meggie_Erdman33@gmail.com\",\n \"ssn\": \"123456789\",\n \"date_of_birth\": \"1985-03-22\",\n \"state\": \"TX\"\n },\n \"products\": [\"County Criminal\", \"National Criminal\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/transactions","description":"

Order background check products without emailing the person. A task is created for the client's team to complete the person's details in PSBI.

Use this when your client collects the information and consent themselves.

The body is the same as Create Consumer Transaction, with transaction_type set to \"client\".

\n","urlObject":{"path":["api","v1","partners","transactions"],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"583e8659-4aea-43d4-82c7-9895ab3d159d","name":"Accepted (async)","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"your-api-key","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\": [\n \"County Criminal\",\n \"National Criminal\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.psbi.com/api/v1/partners/transactions"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"transaction_id\": 5115,\n \"external_id\": \"CLIENT_67890\",\n \"status\": \"received\",\n \"message\": \"Transaction received and queued for processing\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"estimated_completion\": \"2026-09-18T14:02:11.000000Z\",\n \"tracking_url\": null,\n \"consumer\": {\n \"id\": null,\n \"name\": \"Jane Smith\",\n \"email\": \"jane.smith@example.com\"\n }\n}"}],"_postman_id":"c8dbbc52-ac52-46f3-a1d0-d2e0bf8e1189"},{"name":"Get Transaction Status","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status retrieved\", function () {"," pm.expect([200, 404]).to.include(pm.response.code);","});"]}}],"id":"684756fa-9000-4ddd-8c55-8957e9096fbb","request":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key-here","type":"text","description":"

Your API key

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

Look up any request on your connection by external_id. This covers Gateway orders and AutoPilot enrollments.

Response

\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
`transaction.id`	PSBI's request id, prefixed `PTX-`.
`transaction.status`	Processing of your request: `received`, `processing`, `processed` or `failed`.
`transaction.error_message`	Why a request `failed`.
`transaction.consumer_transaction`	The order, once created: `id`, `status` (`draft`, `review`, `processing`, `complete`, `cancelled`), `estimated_total`, `submitted_at`, `consumer`.
`transaction.status_updates`	The five most recent status webhooks PSBI attempted for this request: `event`, `status` (`sent`, `failed`, `retrying` or `pending`), `timestamp`, `delivered_at`. Useful for confirming your endpoint received them.

","urlObject":{"path":["api","v1","partners","transactions",""],"host":["https://app.psbi.com"],"query":[],"variable":[]}},"response":[{"id":"fba75b9e-979d-4bad-a59c-565ddb825965","name":"In progress","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.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-5114\",\n \"external_id\": \"CONSUMER_12345\",\n \"status\": \"processed\",\n \"transaction_type\": \"consumer\",\n \"received_at\": \"2026-09-15T14:02:11.000000Z\",\n \"processed_at\": \"2026-09-15T14:02:43.000000Z\",\n \"error_message\": null,\n \"consumer_transaction\": {\n \"id\": 98765,\n \"status\": \"processing\",\n \"estimated_total\": \"45.00\",\n \"submitted_at\": \"2026-09-16T09:12:40.000000Z\",\n \"consumer\": {\n \"id\": 54321,\n \"name\": \"John Doe\"\n }\n },\n \"status_updates\": [\n {\n \"event\": \"consumer.transaction.submitted\",\n \"status\": \"sent\",\n \"timestamp\": \"2026-09-16T09:12:41.000000Z\",\n \"delivered_at\": \"2026-09-16T09:12:41.000000Z\"\n },\n {\n \"event\": \"consumer.transaction.review\",\n \"status\": \"sent\",\n \"timestamp\": \"2026-09-16T09:10:02.000000Z\",\n \"delivered_at\": \"2026-09-16T09:10:02.000000Z\"\n }\n ]\n }\n}"},{"id":"e02d9859-7971-4fb5-a960-72ab7aa4a267","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"X-API-Key","value":"your-api-key","type":"text"}],"url":"https://app.psbi.com/api/v1/partners/transactions/UNKNOWN_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":"684756fa-9000-4ddd-8c55-8957e9096fbb"}],"id":"73d74ad4-20ea-4a78-b508-cbc92c178fb1","description":"

Partner Gateway

Order specific background check products for a person.

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

`transaction_type`	Who completes the person's information
`consumer` (default)	The person, through an email invitation.
`client`	The client's team, through a task in PSBI.

Flow

Create the transaction with your external_id.
The person or the client's team completes the information. The order then moves to review and is submitted.
Receive status webhooks, or poll Get Transaction Status.
When the order is complete, the report-ready webhook carries a link to download the report.

To enroll people into positions and keep them compliant over time, use the AutoPilot API instead.

\n","_postman_id":"73d74ad4-20ea-4a78-b508-cbc92c178fb1"},{"name":"Status Webhooks","item":[{"name":"Review","id":"1ad4722a-77f9-4387-bd1f-5e27c7c949c2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"P51-Partner-Gateway/1.0","type":"text"},{"key":"X-P51-Event","value":"consumer.transaction.review","type":"text"},{"key":"X-P51-Timestamp","value":"2026-09-15T18:22:31.000000Z","type":"text"},{"key":"X-P51-Signature","value":"3f1c9a0e7b…","type":"text","description":"

Hex HMAC-SHA256 of the raw body with your signing secret

\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"consumer.transaction.review\",\n \"status\": \"review\",\n \"external_id\": \"HR-2026-001234\",\n \"consumer_transaction_id\": \"98765\",\n \"consumer\": {\n \"id\": \"54321\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"portal_url\": \"https://app.psbi.com/client/consumers/54321/transactions/98765/review\",\n \"occurred_at\": \"2026-09-15T18:22:31Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-app.example.com/psbi/webhooks","description":"

Sent by PSBI to your endpoint.

The person's information is collected and the order is waiting to be submitted, either by the client's team at portal_url or automatically. It is not a results review; nothing has been searched yet.

Suggested handling: mark the record as waiting to be submitted.

\n","urlObject":{"host":["https://your-app.example.com/psbi/webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ad4722a-77f9-4387-bd1f-5e27c7c949c2"},{"name":"In Progress","id":"0000fc28-31ef-45ee-a9eb-8eb8076a0ce2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"P51-Partner-Gateway/1.0","type":"text"},{"key":"X-P51-Event","value":"consumer.transaction.submitted","type":"text"},{"key":"X-P51-Timestamp","value":"2026-09-15T18:22:31.000000Z","type":"text"},{"key":"X-P51-Signature","value":"3f1c9a0e7b…","type":"text","description":"

Hex HMAC-SHA256 of the raw body with your signing secret

\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"consumer.transaction.submitted\",\n \"status\": \"in_progress\",\n \"external_id\": \"HR-2026-001234\",\n \"consumer_transaction_id\": \"98765\",\n \"consumer\": {\n \"id\": \"54321\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"portal_url\": \"https://app.psbi.com/client/autopilot/consumers/54321\",\n \"occurred_at\": \"2026-09-15T18:22:31Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-app.example.com/psbi/webhooks","description":"

Sent by PSBI to your endpoint.

The order is submitted and searches are running. Turnaround depends on the searches; county courts can take several business days.

Suggested handling: mark the record as screening in progress.

\n","urlObject":{"host":["https://your-app.example.com/psbi/webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"0000fc28-31ef-45ee-a9eb-8eb8076a0ce2"},{"name":"Complete","id":"b4f8b2dc-dfa8-423a-8770-3260124be010","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"P51-Partner-Gateway/1.0","type":"text"},{"key":"X-P51-Event","value":"consumer.transaction.completed","type":"text"},{"key":"X-P51-Timestamp","value":"2026-09-15T18:22:31.000000Z","type":"text"},{"key":"X-P51-Signature","value":"3f1c9a0e7b…","type":"text","description":"

Hex HMAC-SHA256 of the raw body with your signing secret

\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"consumer.transaction.completed\",\n \"status\": \"complete\",\n \"external_id\": \"HR-2026-001234\",\n \"consumer_transaction_id\": \"98765\",\n \"consumer\": {\n \"id\": \"54321\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"portal_url\": \"https://app.psbi.com/client/autopilot/consumers/54321\",\n \"occurred_at\": \"2026-09-15T18:22:31Z\",\n \"result\": \"needs_review\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-app.example.com/psbi/webhooks","description":"

Sent by PSBI to your endpoint.

Every search is finished.

result: \"clear\": nothing needs review.
result: \"needs_review\": at least one search returned something to review. The client adjudicates in PSBI at portal_url. Do not treat needs_review as a failed or adverse decision.

The report PDF follows in Report Ready.

\n","urlObject":{"host":["https://your-app.example.com/psbi/webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4f8b2dc-dfa8-423a-8770-3260124be010"},{"name":"Report Ready","id":"e11c703c-778e-4a89-8ca0-cba28996e8a1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"P51-Partner-Gateway/1.0","type":"text"},{"key":"X-P51-Event","value":"consumer.transaction.report_generated","type":"text"},{"key":"X-P51-Timestamp","value":"2026-09-15T18:22:31.000000Z","type":"text"},{"key":"X-P51-Signature","value":"3f1c9a0e7b…","type":"text","description":"

Hex HMAC-SHA256 of the raw body with your signing secret

\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"consumer.transaction.report_generated\",\n \"status\": \"complete\",\n \"external_id\": \"HR-2026-001234\",\n \"consumer_transaction_id\": \"98765\",\n \"consumer\": {\n \"id\": \"54321\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n },\n \"portal_url\": \"https://app.psbi.com/client/autopilot/consumers/54321\",\n \"occurred_at\": \"2026-09-15T18:22:31Z\",\n \"result\": \"needs_review\",\n \"report_url\": \"https:///reports/98765.pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-app.example.com/psbi/webhooks","description":"

Sent by PSBI to your endpoint.

The report PDF is generated. Download it from report_url straight away and store it with the same care as any consumer report. result repeats the outcome from Complete.

\n","urlObject":{"host":["https://your-app.example.com/psbi/webhooks"],"query":[],"variable":[]}},"response":[],"_postman_id":"e11c703c-778e-4a89-8ca0-cba28996e8a1"}],"id":"5e523db0-67e9-4371-9d93-fe4eb273a55a","description":"

Status Webhooks

PSBI posts to your HTTPS endpoint as an order moves through screening. These are requests PSBI sends to you, not endpoints you call.

Turning them on

Send your implementation contact:

the HTTPS URL that should receive webhooks.

PSBI registers it on your connection and gives you a signing secret. Webhooks then cover every order created through your API key, from both AutoPilot enrollments and Gateway transactions.

Events

\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

`event`	`status`	When
`consumer.transaction.review`	`review`	The person's information is collected and the order is waiting to be submitted. This is not a results review. On accounts that submit automatically, `in_progress` follows within seconds.
`consumer.transaction.submitted`	`in_progress`	The order is submitted and searches are running.
`consumer.transaction.completed`	`complete`	Every search is finished. `result` says whether anything needs review.
`consumer.transaction.report_generated`	`complete`	The report PDF is ready. `report_url` links to it. This usually follows `completed` within minutes.

Body

Every event has the same shape. All values are strings.

\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	Description
`event`	The event name from the table above.
`status`	`review`, `in_progress` or `complete`.
`external_id`	The `external_id` you sent when you enrolled or ordered.
`consumer_transaction_id`	PSBI's order id.
`consumer.id`, `consumer.first_name`, `consumer.last_name`	The person.
`portal_url`	Where a client user views this in PSBI (a PSBI login is required). On `review` it opens the order's submit page.
`occurred_at`	When PSBI generated the webhook (UTC).
`result`	`completed` and `report_generated` only. `clear` means no search needs review. `needs_review` means at least one search returned something to review, such as a record found or a verification that could not be confirmed. Adjudication happens in PSBI.
`report_url`	`report_generated` only. A download link for the report PDF. It is a consumer report, so fetch and store it securely straight away rather than keeping the link.

{\n  \"event\": \"consumer.transaction.completed\",\n  \"status\": \"complete\",\n  \"external_id\": \"HR-2026-001234\",\n  \"consumer_transaction_id\": \"98765\",\n  \"consumer\": {\n    \"id\": \"54321\",\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\"\n  },\n  \"portal_url\": \"https://app.psbi.com/client/autopilot/consumers/54321\",\n  \"occurred_at\": \"2026-09-15T18:22:31Z\",\n  \"result\": \"needs_review\"\n}\n

Headers

\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

Header	Value
`Content-Type`	`application/json`
`User-Agent`	`P51-Partner-Gateway/1.0`
`X-P51-Event`	The event name.
`X-P51-Timestamp`	When the request was sent (ISO 8601).
`X-P51-Signature`	Lowercase hex HMAC-SHA256 of the raw request body, keyed with your signing secret.

Verifying the signature

Compute the HMAC over the exact bytes you received, before parsing the JSON, and compare it in constant time. Reject anything that does not match.

const crypto = require('crypto');\n\n// Express: app.post('/psbi/webhooks', express.raw({ type: 'application/json' }), handler)\nfunction isFromPsbi(rawBody, signatureHeader, secret) {\n  const expected = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');\n  const received = String(signatureHeader || '').replace(/^sha256=/, '');\n  return received.length === expected.length &&\n    crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected));\n}\n

$raw = file_get_contents('php://input');\n$expected = hash_hmac('sha256', $raw, $secret);\n\nif (! hash_equals($expected, $_SERVER['HTTP_X_P51_SIGNATURE'] ?? '')) {\n    http_response_code(401);\n    exit;\n}\n

Responding

Return any 2xx within 30 seconds. Acknowledge first and do slow work afterwards.
A timeout or any non-2xx counts as a failed delivery. PSBI tries 3 times in total, about a minute apart.

Designing your receiver

Duplicates happen. A retry after a slow response can deliver the same event twice. Deduplicate on external_id + event + occurred_at, or make your updates idempotent.
Order is not guaranteed. Don't move a record backwards, for example from complete to in_progress.
Not every order sends every event. review can be followed immediately by in_progress. An order that is reopened and completed again sends completed and report_generated again; treat the latest one as current.
What sends no webhooks:
- enroll_only enrollments
- a transition with no new requirements
- an enroll that found the person already active in that position
- orders PSBI creates later on its own, such as renewals
\n
Missed one? Get Enrollment Status and Get Transaction Status return the order's current status, so you can reconcile.

\n","_postman_id":"5e523db0-67e9-4371-9d93-fe4eb273a55a"}],"event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Response time is acceptable\", function () {"," pm.expect(pm.response.responseTime).to.be.below(30000);","});"]}}],"variable":[{"key":"base_url","value":"https://app.psbi.com","type":"string","description":"PSBI API base URL."},{"key":"api_key","value":"your-api-key-here","type":"string","description":"Your API key from the PSBI implementation team."},{"key":"your_webhook_url","value":"https://your-app.example.com/psbi/webhooks","type":"string","description":"Your webhook endpoint (used by the Status Webhooks examples)."},{"key":"last_autopilot_external_id","value":"","type":"string","description":"Set by the enroll requests."},{"key":"last_consumer_id","value":"","type":"string","description":"Set by synchronous enroll requests; used by Transition by Consumer ID."},{"key":"last_transition_id","value":"","type":"string","description":"Set by the transition requests."},{"key":"last_gateway_external_id","value":"","type":"string","description":"Set by the Gateway create requests."}]}