{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "..\/" } ], "info": { "name": "TurboPass Partner Api Documentation", "_postman_id": "13922f4f-2f6c-4866-abeb-9fbbd86ebb4b", "description": "This documentation is for partners of TurboPass, to create organizations and order TurboPass reports on behalf of those organizations.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Organizations", "description": "", "item": [ { "name": "Get Organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/organization\/get", "query": [], "raw": "{{baseUrl}}\/api\/v2\/organization\/get" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uuid\":\"15328667-0cdb-3773-bc04-ac01d54c1b2b\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Organization returned.\",\"organization\":{\"uuid\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\",\"name\":\"test organization\",\"type\":\"dealer\",\"primary_address\":\"200 test street\",\"secondary_address\":\"unit 101\",\"city\":\"los angeles\",\"state\":\"ca\",\"postal_code\":\"90210\",\"country_code\":\"US\",\"phone_number\":\"0000000000\",\"is_buy_here_pay_here\":true}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Organization not found.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Create Organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/organization\/create", "query": [], "raw": "{{baseUrl}}\/api\/v2\/organization\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"voluptates\",\"type\":\"dealer\",\"primary_address\":\"consequatur\",\"city\":\"veritatis\",\"state\":\"repellendus\",\"country_code\":\"h\",\"postal_code\":\"qbnvkkupj\",\"phone_number\":\"ybkfzipzle\",\"email_address\":\"doris94@example.net\",\"contact_first_name\":\"nksfvljlhrqywmbngfejwkbrv\",\"contact_last_name\":\"okbziyyhhcdhklh\",\"contact_phone\":\"zmabcvsb\",\"is_buy_here_pay_here\":false,\"plan_effective_date\":\"2026-04-10T13:09:09\",\"end_date\":\"2026-04-10T13:09:09\",\"status\":\"partner active\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Organization was created\",\"organization_uuid\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"This organization already exists.\",\"errors\":{\"name\":\"This name in conjunction with provided postal code already exists.\",\"postal_code\":\"This postal code in conjunction with provided name already exists.\"}}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Update Organization Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/organization\/update-status", "query": [], "raw": "{{baseUrl}}\/api\/v2\/organization\/update-status" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uuid\":\"6667fd59-9920-3c88-bbab-e2a8de3cafa1\",\"status\":\"partner active\",\"plan_id\":\"dc_standard\",\"plan_effective_date\":\"2024-08-30\",\"end_date\":\"2026-04-10T13:09:09\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Organization updated.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Organization not found.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Update Organization Reference ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/organization\/update-reference-id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/organization\/update-reference-id" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uuid\":\"7c60863a-dd4d-35d6-a43c-61ec588b267a\",\"reference_id\":\"123456\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Organization reference id updated.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Organization not found.\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"Organization reference id not updated due to a conflict. Contact support for more information.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4e82d459-1ecd-433d-8b58-a038c9dd0cd6\"}", "name": "" } ] }, { "name": "Update Organization Plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/organization\/update-plan-id", "query": [], "raw": "{{baseUrl}}\/api\/v2\/organization\/update-plan-id" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"uuid\":\"a6919da9-c80b-3ee1-a96a-cdd58625f6d1\",\"plan_id\":\"dc_standard\",\"plan_effective_date\":\"2024-08-30\",\"end_date\":\"2026-04-10T13:09:09\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Organization plan updated.\"}", "name": "" }, { "header": [], "code": 200, "body": "{\"message\":\"Organization plan staged.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Organization not found.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"5eb08922-9ecg-5793-92g6-6b1d9ggg2f5z\"}", "name": "" } ] } ] }, { "name": "Personal Access Tokens", "description": "", "item": [ { "name": "Create Personal Access Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/pat\/create", "query": [], "raw": "{{baseUrl}}\/api\/v2\/pat\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"schuppe.ebony@example.net\",\"password\":\"kfx0t]sfF?]4cE:#p\",\"name\":\"nisi\",\"webhook_url\":\"https:\\\/\\\/www.gaylord.com\\\/eos-voluptas-eveniet-iste-sit-magni-rerum-fugiat\",\"scopes\":[\"get-organization\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Personal Access Token was created.\",\"personal_access_token\":\"4da078118daf468281f55a0b8ffe1e4a\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Authentication Failed.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] } ] }, { "name": "TurboPasses", "description": "", "item": [ { "name": "Create TurboPass", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/turbopass\/create", "query": [], "raw": "{{baseUrl}}\/api\/v2\/turbopass\/create" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"organization_uuid\":\"9eed76e5-a456-3de3-ba73-2cb6ea30b06c\",\"report_type\":\"bravo\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"last_four_ssn\":\"1234\",\"email_address\":\"john.doe@email.com\",\"silent_invitation\":false,\"reference_number\":\"ref123456\",\"webhook_url\":\"http:\\\/\\\/www.konopelski.com\\\/\",\"language\":\"en\",\"should_include_face_match\":true,\"customer_id\":\"CUST-1234-1\",\"deal_id\":\"DEAL-1234-1\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"TurboPass was created.\",\"turbopass_code\":\"skilled-chipmunk-k59-fql-4qp-1670605317\",\"billing_identifier\":\"1234-1\"}", "name": "" }, { "header": [], "code": 400, "body": "{\"message\":\"The required data is either missing or improperly formatted.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"Your organization does not have a trust relationship with the requested organization.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Organization not found.\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"A TurboPass was already created in the previous hour for the provided details.\",\"turbopass_code\":\"skilled-chipmunk-k59-fql-4qp-1670605317\",\"billing_identifier\":\"1234-1\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"Organization is owned by TurboPass.\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"Your organization is inactive, plase call TurboPass at 855-667-8477.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Get TurboPass Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/turbopass\/status", "query": [], "raw": "{{baseUrl}}\/api\/v2\/turbopass\/status" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"voluptas\"}" }, "description": "Gets the status of a TurboPass report" }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"Report Ready\",\"friendly_status\":\"Report Ready\",\"status_message\":\"The consumer has successfully completed their verification. TurboPass AI is currently processing the results.\",\"message\":\"TurboPass has successfully built the report, and the report is now ready for viewing.\"}", "name": "" }, { "header": [], "code": 202, "body": "{\"message\":\"This TurboPass has not yet been completed. Last status is [status]. Meaning: [meaning]\",\"status\":\"Processing Data\",\"friendly_status\":\"Processing Results\",\"status_message\":\"The consumer has successfully completed their verification. TurboPass AI is currently processing the results.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized,\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"TurboPass not found.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Get TurboPass Report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/turbopass\/report", "query": [], "raw": "{{baseUrl}}\/api\/v2\/turbopass\/report" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"simple-parakeet-identity-ab1u-r4e9-34yp\",\"exclude_id_documents\":false,\"output\":\"json\"}" }, "description": "Gets the output of a TurboPass report" }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Report has been retrieved.\",\"output\":{\"type\":\"pdf\",\"payload\":\"example.url.com\"}}", "name": "" }, { "header": [], "code": 200, "body": "{\"message\":\"Report has been retrieved.\",\"output\":{\"type\":\"json\",\"payload\":[]}}", "name": "" }, { "header": [], "code": 202, "body": "{\"message\":\"This TurboPass has not yet been completed. Last status is [status]. Meaning: [meaning]\",\"status\":\"Processing Data\",\"friendly_status\":\"Processing Results\",\"status_message\":\"The consumer has successfully completed their verification. TurboPass AI is currently processing the results.\"}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized,\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"TurboPass not found.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"This report type is not currently available through this API endpoint.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"This report type is not currently available in JSON format.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"4da07811-8daf-4682-81f5-5a0b8ffe1e4a\"}", "name": "" } ] }, { "name": "Resend a TurboPass Invite", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v2\/turbopass\/resend-invite", "query": [], "raw": "{{baseUrl}}\/api\/v2\/turbopass\/resend-invite" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"turbopass_code\":\"id\"}" }, "description": "Returns success or fail." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Invite queued for re-notification.\",\"output\":{\"type\":\"json\"}}", "name": "" }, { "header": [], "code": 200, "body": "{\"message\":\"Notification was not re-sent.\",\"output\":{\"type\":\"json\"}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"This action is unauthorized,\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"TurboPass not found.\"}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\":\"Can not resend invite once Consumer Intake is complete.\"}", "name": "" }, { "header": [], "code": 500, "body": "{\"message\":\"An error has occurred. Please try again and if the issue persists, contact our support team with a provided identifier.\",\"identifier\":\"3da07812-9daf-5681-71f4-6a0b8ffe1e4c\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "personal_access_token", "type": "string" } ] } }