curl --request GET \
--url https://api.verify.privue.ai/workflows \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/workflows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verify.privue.ai/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workflows": [
{
"key": "merchant-onboarding",
"name": "Merchant onboarding",
"mode": "hosted",
"version": 3,
"expires_after_days": 30,
"step_count": 12,
"environment": "production",
"credits": {
"granted": 700,
"consumed": 412,
"expired": 0,
"revoked": 0,
"remaining": 288,
"expiring": [
{
"amount": 88,
"on": "2026-09-30"
},
{
"amount": 200,
"on": "2027-03-31"
}
]
},
"runs": {
"live": 17,
"limit": 25
},
"resets": {
"granted": 50,
"drawn": 6,
"expired": 0,
"revoked": 0,
"remaining": 44,
"expiring": [
{
"amount": 24,
"on": "2027-03-31"
},
{
"amount": 20,
"on": "2027-06-30"
}
]
}
},
{
"key": "vendor-verification",
"name": "Vendor verification",
"mode": "staged",
"version": 1,
"expires_after_days": 30,
"environment": "production",
"credits": {
"granted": 100,
"consumed": 100,
"expired": 0,
"revoked": 0,
"remaining": 0,
"expiring": []
},
"runs": {
"live": 3,
"limit": 25
},
"resets": {
"granted": 20,
"drawn": 2,
"expired": 0,
"revoked": 0,
"remaining": 18,
"expiring": [
{
"amount": 18,
"on": "2027-06-30"
}
]
},
"step_count": 5
}
]
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "client-not-enrolled",
"detail": "no active verification client 4b8f21c6-59ad-4a70-9e11-7c3d0a52f8b4"
}{
"code": "rate-limited",
"detail": "Unauthorized: RATE_LIMITED"
}{
"code": "auth-unavailable",
"detail": "Auth provider unavailable"
}List your workflows
List the workflows you can start a verification on.
One entry per workflow in your API key’s environment, naming the workflow_key a create takes, how it is conducted, how long a verification on it holds a user’s data, how many steps it declares, and where it stands on each of the limits its verifications are held to. Read a single workflow for the steps themselves.
A key is for one environment and reaches only that one’s workflows, so a uat key lists your test journeys and a production key lists your real ones.
A workflow that has been taken out of use is not listed. The verifications that ran it stay readable, and go on naming it as their workflow_key.
curl --request GET \
--url https://api.verify.privue.ai/workflows \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/workflows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.verify.privue.ai/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workflows": [
{
"key": "merchant-onboarding",
"name": "Merchant onboarding",
"mode": "hosted",
"version": 3,
"expires_after_days": 30,
"step_count": 12,
"environment": "production",
"credits": {
"granted": 700,
"consumed": 412,
"expired": 0,
"revoked": 0,
"remaining": 288,
"expiring": [
{
"amount": 88,
"on": "2026-09-30"
},
{
"amount": 200,
"on": "2027-03-31"
}
]
},
"runs": {
"live": 17,
"limit": 25
},
"resets": {
"granted": 50,
"drawn": 6,
"expired": 0,
"revoked": 0,
"remaining": 44,
"expiring": [
{
"amount": 24,
"on": "2027-03-31"
},
{
"amount": 20,
"on": "2027-06-30"
}
]
}
},
{
"key": "vendor-verification",
"name": "Vendor verification",
"mode": "staged",
"version": 1,
"expires_after_days": 30,
"environment": "production",
"credits": {
"granted": 100,
"consumed": 100,
"expired": 0,
"revoked": 0,
"remaining": 0,
"expiring": []
},
"runs": {
"live": 3,
"limit": 25
},
"resets": {
"granted": 20,
"drawn": 2,
"expired": 0,
"revoked": 0,
"remaining": 18,
"expiring": [
{
"amount": 18,
"on": "2027-06-30"
}
]
},
"step_count": 5
}
]
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "client-not-enrolled",
"detail": "no active verification client 4b8f21c6-59ad-4a70-9e11-7c3d0a52f8b4"
}{
"code": "rate-limited",
"detail": "Unauthorized: RATE_LIMITED"
}{
"code": "auth-unavailable",
"detail": "Auth provider unavailable"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Every workflow your API key's environment holds.
The workflows configured for you.
Your workflows, ordered by key.
Show child attributes
Show child attributes
