MENU navbar-image

Introduction

This documentation is for partners of TurboPass, to create organizations and order TurboPass reports on behalf of those organizations.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer personal-access-token".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Create a personal access token using the endpoint with your partner username and password

Organizations

Get Organization

requires authentication

Example request:
curl --request GET \
    --get "https://app.turbopasspoi.com/api/v2/organization/get" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"e7b7f3d7-5d1e-30ae-8a62-f1000445e523\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/organization/get';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => 'e7b7f3d7-5d1e-30ae-8a62-f1000445e523',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/organization/get"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "e7b7f3d7-5d1e-30ae-8a62-f1000445e523"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/organization/get'
payload = {
    "uuid": "e7b7f3d7-5d1e-30ae-8a62-f1000445e523"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "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
    }
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized."
}

Example response (404):

                                                        
                    {
    "message": "Organization not found."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

GET api/v2/organization/get

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string   

Must be a valid UUID. Example: e7b7f3d7-5d1e-30ae-8a62-f1000445e523

Create Organization

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/organization/create" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aut\",
    \"type\": \"lender\",
    \"primary_address\": \"iusto\",
    \"city\": \"modi\",
    \"state\": \"perferendis\",
    \"country_code\": \"xr\",
    \"postal_code\": \"m\",
    \"phone_number\": \"gw\",
    \"email_address\": \"[email protected]\",
    \"contact_first_name\": \"tq\",
    \"contact_last_name\": \"gsq\",
    \"contact_phone\": \"v\",
    \"is_buy_here_pay_here\": true,
    \"plan_effective_date\": \"2024-12-19T17:25:22\",
    \"end_date\": \"2024-12-19T17:25:22\",
    \"status\": \"partner active\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/organization/create';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'aut',
            'type' => 'lender',
            'primary_address' => 'iusto',
            'city' => 'modi',
            'state' => 'perferendis',
            'country_code' => 'xr',
            'postal_code' => 'm',
            'phone_number' => 'gw',
            'email_address' => '[email protected]',
            'contact_first_name' => 'tq',
            'contact_last_name' => 'gsq',
            'contact_phone' => 'v',
            'is_buy_here_pay_here' => true,
            'plan_effective_date' => '2024-12-19T17:25:22',
            'end_date' => '2024-12-19T17:25:22',
            'status' => 'partner active',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/organization/create"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "aut",
    "type": "lender",
    "primary_address": "iusto",
    "city": "modi",
    "state": "perferendis",
    "country_code": "xr",
    "postal_code": "m",
    "phone_number": "gw",
    "email_address": "[email protected]",
    "contact_first_name": "tq",
    "contact_last_name": "gsq",
    "contact_phone": "v",
    "is_buy_here_pay_here": true,
    "plan_effective_date": "2024-12-19T17:25:22",
    "end_date": "2024-12-19T17:25:22",
    "status": "partner active"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/organization/create'
payload = {
    "name": "aut",
    "type": "lender",
    "primary_address": "iusto",
    "city": "modi",
    "state": "perferendis",
    "country_code": "xr",
    "postal_code": "m",
    "phone_number": "gw",
    "email_address": "[email protected]",
    "contact_first_name": "tq",
    "contact_last_name": "gsq",
    "contact_phone": "v",
    "is_buy_here_pay_here": true,
    "plan_effective_date": "2024-12-19T17:25:22",
    "end_date": "2024-12-19T17:25:22",
    "status": "partner active"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Organization was created",
    "organization_uuid": "4da07811-8daf-4682-81f5-5a0b8ffe1e4a"
}

Example response (409):

                                                        
                    {
    "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."
    }
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/organization/create

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Example: aut

type   string   

Example: lender

Must be one of:
  • dealer
  • lender
primary_address   string   

Example: iusto

secondary_address   string  optional  
city   string   

Example: modi

state   string   

Example: perferendis

country_code   string   

Must not be greater than 3 characters. Example: xr

postal_code   string   

Must not be greater than 12 characters. Example: m

phone_number   string   

Must be at least 10 characters. Must not be greater than 11 characters. Example: gw

email_address   string  optional  

Must be a valid email address. Example: [email protected]

contact_first_name   string  optional  

Must not be greater than 50 characters. Example: tq

contact_last_name   string  optional  

Must not be greater than 50 characters. Example: gsq

contact_phone   string  optional  

Must not be greater than 25 characters. Example: v

is_buy_here_pay_here   boolean  optional  

Example: true

reference_id   string|int  optional  
plan_id   string  optional  
plan_effective_date   string  optional  

Must be a valid date. Example: 2024-12-19T17:25:22

end_date   string  optional  

Must be a valid date. Example: 2024-12-19T17:25:22

status   string  optional  

Example: partner active

Must be one of:
  • partner active
  • partner free trial

Update Organization Status

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/organization/update-status" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"cbb30081-15ec-3914-a297-e63568227590\",
    \"status\": \"partner active\",
    \"plan_id\": \"dc_standard\",
    \"plan_effective_date\": \"2024-08-30\",
    \"end_date\": \"2024-12-19T17:25:22\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/organization/update-status';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => 'cbb30081-15ec-3914-a297-e63568227590',
            'status' => 'partner active',
            'plan_id' => 'dc_standard',
            'plan_effective_date' => '2024-08-30',
            'end_date' => '2024-12-19T17:25:22',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/organization/update-status"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "cbb30081-15ec-3914-a297-e63568227590",
    "status": "partner active",
    "plan_id": "dc_standard",
    "plan_effective_date": "2024-08-30",
    "end_date": "2024-12-19T17:25:22"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/organization/update-status'
payload = {
    "uuid": "cbb30081-15ec-3914-a297-e63568227590",
    "status": "partner active",
    "plan_id": "dc_standard",
    "plan_effective_date": "2024-08-30",
    "end_date": "2024-12-19T17:25:22"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Organization updated."
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized."
}

Example response (404):

                                                        
                    {
    "message": "Organization not found."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/organization/update-status

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string   

UUID of Organization TurboPass is for. Example: cbb30081-15ec-3914-a297-e63568227590

status   string   

Must be one of 'partner active' or 'partner canceled' Example: partner active

plan_id   string  optional  

optional Partner-specific plan_id's Example: dc_standard

plan_effective_date   string  optional  

optional A valid date Example: 2024-08-30

end_date   string  optional  

Must be a valid date. Example: 2024-12-19T17:25:22

Update Organization Reference ID

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/organization/update-reference-id" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"0d89bbea-beeb-3e27-9f47-d7f1fe3e5b83\",
    \"reference_id\": \"123456\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/organization/update-reference-id';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '0d89bbea-beeb-3e27-9f47-d7f1fe3e5b83',
            'reference_id' => '123456',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/organization/update-reference-id"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "0d89bbea-beeb-3e27-9f47-d7f1fe3e5b83",
    "reference_id": "123456"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/organization/update-reference-id'
payload = {
    "uuid": "0d89bbea-beeb-3e27-9f47-d7f1fe3e5b83",
    "reference_id": "123456"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Organization reference id updated."
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized."
}

Example response (404):

                                                        
                    {
    "message": "Organization not found."
}

Example response (409):

                                                        
                    {
    "message": "Organization reference id not updated due to a conflict. Contact support for more information."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/organization/update-reference-id

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string   

UUID of Organization TurboPass is for. Example: 0d89bbea-beeb-3e27-9f47-d7f1fe3e5b83

reference_id   string|int   

Partner reference ID for organization Example: 123456

Update Organization Plan

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/organization/update-plan-id" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"7d72a2d8-8941-344f-95cc-fdffbb9e786d\",
    \"plan_id\": \"dc_standard\",
    \"plan_effective_date\": \"2024-08-30\",
    \"end_date\": \"2024-12-19T17:25:23\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/organization/update-plan-id';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '7d72a2d8-8941-344f-95cc-fdffbb9e786d',
            'plan_id' => 'dc_standard',
            'plan_effective_date' => '2024-08-30',
            'end_date' => '2024-12-19T17:25:23',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/organization/update-plan-id"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "7d72a2d8-8941-344f-95cc-fdffbb9e786d",
    "plan_id": "dc_standard",
    "plan_effective_date": "2024-08-30",
    "end_date": "2024-12-19T17:25:23"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/organization/update-plan-id'
payload = {
    "uuid": "7d72a2d8-8941-344f-95cc-fdffbb9e786d",
    "plan_id": "dc_standard",
    "plan_effective_date": "2024-08-30",
    "end_date": "2024-12-19T17:25:23"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Organization plan updated."
}

Example response (200):

                                                        
                    {
    "message": "Organization plan staged."
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized."
}

Example response (404):

                                                        
                    {
    "message": "Organization not found."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/organization/update-plan-id

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string   

UUID of Organization TurboPass is for. Example: 7d72a2d8-8941-344f-95cc-fdffbb9e786d

plan_id   string   

Partner-specific plan_id's - speak with your partner account representative for whether this endpoint is needed for your integration. Example: dc_standard

plan_effective_date   string  optional  

optional A valid date Example: 2024-08-30

end_date   string  optional  

Must be a valid date. Example: 2024-12-19T17:25:23

Personal Access Tokens

Create Personal Access Token

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/pat/create" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"JwaQT;`FSIgD\\/\",
    \"name\": \"dicta\",
    \"webhook_url\": \"http:\\/\\/maggio.com\\/voluptatem-qui-qui-voluptatem-omnis-distinctio-eveniet-sequi-recusandae\",
    \"scopes\": [
        \"get-organization\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/pat/create';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => '[email protected]',
            'password' => 'JwaQT;`FSIgD/',
            'name' => 'dicta',
            'webhook_url' => 'http://maggio.com/voluptatem-qui-qui-voluptatem-omnis-distinctio-eveniet-sequi-recusandae',
            'scopes' => [
                'get-organization',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/pat/create"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "[email protected]",
    "password": "JwaQT;`FSIgD\/",
    "name": "dicta",
    "webhook_url": "http:\/\/maggio.com\/voluptatem-qui-qui-voluptatem-omnis-distinctio-eveniet-sequi-recusandae",
    "scopes": [
        "get-organization"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/pat/create'
payload = {
    "email": "[email protected]",
    "password": "JwaQT;`FSIgD\/",
    "name": "dicta",
    "webhook_url": "http:\/\/maggio.com\/voluptatem-qui-qui-voluptatem-omnis-distinctio-eveniet-sequi-recusandae",
    "scopes": [
        "get-organization"
    ]
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Personal Access Token was created.",
    "personal_access_token": "4da078118daf468281f55a0b8ffe1e4a"
}

Example response (401):

                                                        
                    {
    "message": "Authentication Failed."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/pat/create

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Must be a valid email address. Example: [email protected]

password   string   

Example: JwaQT;FSIgD/`

name   string   

Example: dicta

webhook_url   string  optional  

Example: http://maggio.com/voluptatem-qui-qui-voluptatem-omnis-distinctio-eveniet-sequi-recusandae

scopes   string[]   
Must be one of:
  • *
  • create-organization
  • create-user
  • create-turbopass
  • get-organization
  • get-turbopass-report
  • get-turbopass-status

TurboPasses

Create TurboPass

requires authentication

Example request:
curl --request POST \
    "https://app.turbopasspoi.com/api/v2/turbopass/create" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"organization_uuid\": \"f39b1133-3b92-321a-bf49-d8fe19f6b4de\",
    \"report_type\": \"bravo\",
    \"first_name\": \"John\",
    \"last_name\": \"Doe\",
    \"last_four_ssn\": \"1234\",
    \"email_address\": \"[email protected]\",
    \"silent_invitation\": false,
    \"reference_number\": \"ref123456\",
    \"webhook_url\": \"https:\\/\\/www.hamill.biz\\/et-enim-sunt-autem-rerum\",
    \"language\": \"en\",
    \"should_include_face_match\": true,
    \"customer_id\": \"CUST-1234-1\",
    \"deal_id\": \"DEAL-1234-1\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/turbopass/create';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'organization_uuid' => 'f39b1133-3b92-321a-bf49-d8fe19f6b4de',
            'report_type' => 'bravo',
            'first_name' => 'John',
            'last_name' => 'Doe',
            'last_four_ssn' => '1234',
            'email_address' => '[email protected]',
            'silent_invitation' => false,
            'reference_number' => 'ref123456',
            'webhook_url' => 'https://www.hamill.biz/et-enim-sunt-autem-rerum',
            'language' => 'en',
            'should_include_face_match' => true,
            'customer_id' => 'CUST-1234-1',
            'deal_id' => 'DEAL-1234-1',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/turbopass/create"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_uuid": "f39b1133-3b92-321a-bf49-d8fe19f6b4de",
    "report_type": "bravo",
    "first_name": "John",
    "last_name": "Doe",
    "last_four_ssn": "1234",
    "email_address": "[email protected]",
    "silent_invitation": false,
    "reference_number": "ref123456",
    "webhook_url": "https:\/\/www.hamill.biz\/et-enim-sunt-autem-rerum",
    "language": "en",
    "should_include_face_match": true,
    "customer_id": "CUST-1234-1",
    "deal_id": "DEAL-1234-1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/turbopass/create'
payload = {
    "organization_uuid": "f39b1133-3b92-321a-bf49-d8fe19f6b4de",
    "report_type": "bravo",
    "first_name": "John",
    "last_name": "Doe",
    "last_four_ssn": "1234",
    "email_address": "[email protected]",
    "silent_invitation": false,
    "reference_number": "ref123456",
    "webhook_url": "https:\/\/www.hamill.biz\/et-enim-sunt-autem-rerum",
    "language": "en",
    "should_include_face_match": true,
    "customer_id": "CUST-1234-1",
    "deal_id": "DEAL-1234-1"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "TurboPass was created.",
    "turbopass_code": "skilled-chipmunk-k59-fql-4qp-1670605317",
    "billing_identifier": "1234-1"
}

Example response (400):

                                                        
                    {
    "message": "The required data is either missing or improperly formatted."
}

Example response (403):

                                                        
                    {
    "message": "Your organization does not have a trust relationship with the requested organization."
}

Example response (404):

                                                        
                    {
    "message": "Organization not found."
}

Example response (409):

                                                        
                    {
    "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"
}

Example response (409):

                                                        
                    {
    "message": "Organization is owned by TurboPass."
}

Example response (409):

                                                        
                    {
    "message": "Your organization is inactive, plase call TurboPass at 855-667-8477."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

POST api/v2/turbopass/create

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

organization_uuid   string   

UUID of Organization TurboPass is for. Example: f39b1133-3b92-321a-bf49-d8fe19f6b4de

report_type   string   

Example: bravo

first_name   string   

Example: John

last_name   string   

Example: Doe

last_four_ssn   string   

Must be at least 4 characters. Must not be greater than 4 characters. Example: 1234

phone_number   string  optional  

This field is required when email_address is not present or if report type is Identity.

email_address   string  optional  

This field is required when phone_number is not present. Must be a valid email address. Example: [email protected]

silent_invitation   boolean  optional  

Example: false

embedded   boolean  optional  

Partner Embed option - Prior approval required.

reference_number   string  optional  

Example: ref123456

webhook_url   string  optional  

This field will override the personal access token webhook_url Example: https://www.hamill.biz/et-enim-sunt-autem-rerum

language   string  optional  

Example: en

should_include_face_match   boolean  optional  

Adds face matching to Identity report. Default is false. Example: true

customer_id   mixed  optional  

Unique external identifier. Used to relate multiple reports to a single customer. | Cannot be used with deal_id. | Example: CUST-1234-1

deal_id   mixed  optional  

Unique external identifier. Used to relate multiple reports to a single deal. | Cannot be used with customer_id. | Example: DEAL-1234-1

Get TurboPass Status

requires authentication

Gets the status of a TurboPass report

Example request:
curl --request GET \
    --get "https://app.turbopasspoi.com/api/v2/turbopass/status" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"libero\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/turbopass/status';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'code' => 'libero',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/turbopass/status"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "libero"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/turbopass/status'
payload = {
    "code": "libero"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "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."
}

Example response (202):

                                                        
                    {
    "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."
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized,"
}

Example response (404):

                                                        
                    {
    "message": "TurboPass not found."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

GET api/v2/turbopass/status

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Example: libero

Get TurboPass Report

requires authentication

Gets the output of a TurboPass report

Example request:
curl --request GET \
    --get "https://app.turbopasspoi.com/api/v2/turbopass/report" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"quis\",
    \"output\": \"pdf\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/turbopass/report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'code' => 'quis',
            'output' => 'pdf',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/turbopass/report"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "quis",
    "output": "pdf"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/turbopass/report'
payload = {
    "code": "quis",
    "output": "pdf"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Report has been retrieved.",
    "output": {
        "type": "pdf",
        "payload": "example.url.com"
    }
}

Example response (200):

                                                        
                    {
    "message": "Report has been retrieved.",
    "output": {
        "type": "json",
        "payload": []
    }
}

Example response (202):

                                                        
                    {
    "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."
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized,"
}

Example response (404):

                                                        
                    {
    "message": "TurboPass not found."
}

Example response (422):

                                                        
                    {
    "message": "This report type is not currently available through this API endpoint."
}

Example response (422):

                                                        
                    {
    "message": "This report type is not currently available in JSON format."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

GET api/v2/turbopass/report

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Example: quis

output   string   

Example: pdf

Must be one of:
  • pdf
  • json

Resend a TurboPass Invite

requires authentication

Returns success or fail.

Example request:
curl --request GET \
    --get "https://app.turbopasspoi.com/api/v2/turbopass/resend-invite" \
    --header "Authorization: Bearer personal-access-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"turbopass_code\": \"nihil\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://app.turbopasspoi.com/api/v2/turbopass/resend-invite';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer personal-access-token',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'turbopass_code' => 'nihil',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://app.turbopasspoi.com/api/v2/turbopass/resend-invite"
);

const headers = {
    "Authorization": "Bearer personal-access-token",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "turbopass_code": "nihil"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
import requests
import json

url = 'https://app.turbopasspoi.com/api/v2/turbopass/resend-invite'
payload = {
    "turbopass_code": "nihil"
}
headers = {
  'Authorization': 'Bearer personal-access-token',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('GET', url, headers=headers, json=payload)
response.json()

Example response (200):

                                                        
                    {
    "message": "Invite queued for re-notification.",
    "output": {
        "type": "json"
    }
}

Example response (200):

                                                        
                    {
    "message": "Notification was not re-sent.",
    "output": {
        "type": "json"
    }
}

Example response (403):

                                                        
                    {
    "message": "This action is unauthorized,"
}

Example response (404):

                                                        
                    {
    "message": "TurboPass not found."
}

Example response (409):

                                                        
                    {
    "message": "Can not resend invite once Consumer Intake is complete."
}

Example response (500):

                                                        
                    {
    "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"
}

Request   

GET api/v2/turbopass/resend-invite

Headers

Authorization      

Example: Bearer personal-access-token

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

turbopass_code   string   

Example: nihil