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\": \"53b8ae3d-8ef4-3756-ba90-665fb31ac8b8\"
}"
$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' => '53b8ae3d-8ef4-3756-ba90-665fb31ac8b8',
],
]
);
$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": "53b8ae3d-8ef4-3756-ba90-665fb31ac8b8"
};
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": "53b8ae3d-8ef4-3756-ba90-665fb31ac8b8"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"pariatur\",
\"type\": \"dealer\",
\"primary_address\": \"et\",
\"city\": \"recusandae\",
\"state\": \"sed\",
\"country_code\": \"gls\",
\"postal_code\": \"mddryjibpx\",
\"phone_number\": \"kfb\",
\"email_address\": \"[email protected]\",
\"contact_first_name\": \"o\",
\"contact_last_name\": \"kglf\",
\"contact_phone\": \"vkaypnsslprvsyqcrld\",
\"is_buy_here_pay_here\": false,
\"plan_effective_date\": \"2024-10-10T18:30:54\",
\"end_date\": \"2024-10-10T18:30:54\",
\"status\": \"partner free trial\"
}"
$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' => 'pariatur',
'type' => 'dealer',
'primary_address' => 'et',
'city' => 'recusandae',
'state' => 'sed',
'country_code' => 'gls',
'postal_code' => 'mddryjibpx',
'phone_number' => 'kfb',
'email_address' => '[email protected]',
'contact_first_name' => 'o',
'contact_last_name' => 'kglf',
'contact_phone' => 'vkaypnsslprvsyqcrld',
'is_buy_here_pay_here' => false,
'plan_effective_date' => '2024-10-10T18:30:54',
'end_date' => '2024-10-10T18:30:54',
'status' => 'partner free trial',
],
]
);
$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": "pariatur",
"type": "dealer",
"primary_address": "et",
"city": "recusandae",
"state": "sed",
"country_code": "gls",
"postal_code": "mddryjibpx",
"phone_number": "kfb",
"email_address": "[email protected]",
"contact_first_name": "o",
"contact_last_name": "kglf",
"contact_phone": "vkaypnsslprvsyqcrld",
"is_buy_here_pay_here": false,
"plan_effective_date": "2024-10-10T18:30:54",
"end_date": "2024-10-10T18:30:54",
"status": "partner free trial"
};
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": "pariatur",
"type": "dealer",
"primary_address": "et",
"city": "recusandae",
"state": "sed",
"country_code": "gls",
"postal_code": "mddryjibpx",
"phone_number": "kfb",
"email_address": "[email protected]",
"contact_first_name": "o",
"contact_last_name": "kglf",
"contact_phone": "vkaypnsslprvsyqcrld",
"is_buy_here_pay_here": false,
"plan_effective_date": "2024-10-10T18:30:54",
"end_date": "2024-10-10T18:30:54",
"status": "partner free trial"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"4a8c012a-23d2-3adc-b519-23d5b758145e\",
\"status\": \"partner active\",
\"plan_id\": \"dc_standard\",
\"plan_effective_date\": \"2024-08-30\",
\"end_date\": \"2024-10-10T18:30:54\"
}"
$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' => '4a8c012a-23d2-3adc-b519-23d5b758145e',
'status' => 'partner active',
'plan_id' => 'dc_standard',
'plan_effective_date' => '2024-08-30',
'end_date' => '2024-10-10T18:30:54',
],
]
);
$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": "4a8c012a-23d2-3adc-b519-23d5b758145e",
"status": "partner active",
"plan_id": "dc_standard",
"plan_effective_date": "2024-08-30",
"end_date": "2024-10-10T18:30:54"
};
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": "4a8c012a-23d2-3adc-b519-23d5b758145e",
"status": "partner active",
"plan_id": "dc_standard",
"plan_effective_date": "2024-08-30",
"end_date": "2024-10-10T18:30:54"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"85095615-b983-3402-86fc-3ee0d3f90370\",
\"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' => '85095615-b983-3402-86fc-3ee0d3f90370',
'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": "85095615-b983-3402-86fc-3ee0d3f90370",
"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": "85095615-b983-3402-86fc-3ee0d3f90370",
"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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"5afd700d-f368-3684-9785-c9d4a6354b4d\",
\"plan_id\": \"dc_standard\",
\"plan_effective_date\": \"2024-08-30\",
\"end_date\": \"2024-10-10T18:30:54\"
}"
$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' => '5afd700d-f368-3684-9785-c9d4a6354b4d',
'plan_id' => 'dc_standard',
'plan_effective_date' => '2024-08-30',
'end_date' => '2024-10-10T18:30:54',
],
]
);
$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": "5afd700d-f368-3684-9785-c9d4a6354b4d",
"plan_id": "dc_standard",
"plan_effective_date": "2024-08-30",
"end_date": "2024-10-10T18:30:54"
};
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": "5afd700d-f368-3684-9785-c9d4a6354b4d",
"plan_id": "dc_standard",
"plan_effective_date": "2024-08-30",
"end_date": "2024-10-10T18:30:54"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"8[u\'S.~m\",
\"name\": \"aut\",
\"webhook_url\": \"http:\\/\\/olson.com\\/architecto-cum-et-fuga-facere-sunt-et-quis-sit\",
\"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' => '8[u\'S.~m',
'name' => 'aut',
'webhook_url' => 'http://olson.com/architecto-cum-et-fuga-facere-sunt-et-quis-sit',
'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": "8[u'S.~m",
"name": "aut",
"webhook_url": "http:\/\/olson.com\/architecto-cum-et-fuga-facere-sunt-et-quis-sit",
"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": "8[u'S.~m",
"name": "aut",
"webhook_url": "http:\/\/olson.com\/architecto-cum-et-fuga-facere-sunt-et-quis-sit",
"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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"121c65f2-3a29-3c91-9562-338bbce610e1\",
\"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\": \"http:\\/\\/hintz.org\\/\",
\"language\": \"en\",
\"should_include_face_match\": false,
\"deal_id\": \"ABCD-1234-1A\"
}"
$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' => '121c65f2-3a29-3c91-9562-338bbce610e1',
'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' => 'http://hintz.org/',
'language' => 'en',
'should_include_face_match' => false,
'deal_id' => 'ABCD-1234-1A',
],
]
);
$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": "121c65f2-3a29-3c91-9562-338bbce610e1",
"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": "http:\/\/hintz.org\/",
"language": "en",
"should_include_face_match": false,
"deal_id": "ABCD-1234-1A"
};
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": "121c65f2-3a29-3c91-9562-338bbce610e1",
"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": "http:\/\/hintz.org\/",
"language": "en",
"should_include_face_match": false,
"deal_id": "ABCD-1234-1A"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"et\"
}"
$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' => 'et',
],
]
);
$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": "et"
};
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": "et"
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"et\",
\"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' => 'et',
'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": "et",
"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": "et",
"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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.
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\": \"perferendis\"
}"
$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' => 'perferendis',
],
]
);
$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": "perferendis"
};
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": "perferendis"
}
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 (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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.