curl --request GET \
--url https://api.verify.privue.ai/verifications/gate-stops \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/verifications/gate-stops"
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/verifications/gate-stops', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"stops": 8,
"workflows": [
{
"workflow_key": "merchant-onboarding",
"stops": 6,
"gates": [
{
"step_key": "already-a-dealer",
"stops": 4,
"gated": 1,
"sent_back": 3
},
{
"step_key": "gst-onboarded",
"stops": 2,
"gated": 2,
"sent_back": 0
}
]
},
{
"workflow_key": "vendor-verification",
"stops": 2,
"gates": [
{
"step_key": "gst-onboarded",
"stops": 2,
"gated": 1,
"sent_back": 1
}
]
}
]
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "client-not-enrolled",
"detail": "no active verification client 4b8f21c6-59ad-4a70-9e11-7c3d0a52f8b4"
}{
"code": "window-invalid",
"detail": "from: must not be after to"
}{
"code": "rate-limited",
"detail": "Unauthorized: RATE_LIMITED"
}{
"code": "auth-unavailable",
"detail": "Auth provider unavailable"
}Count your gate stops
Count the stops your gate checks made, in total, per workflow and per gate check.
Every answer of yours but carry-on is a stop. An amend sends the person back, and the verification stays open. A terminate or a redirect ends the verification as gated, and so does a workflow falling back to either when your system gives no answer. Each gate check reports its stops split into the ones that ended the verification and the ones that sent the person back.
A stop is counted once, whatever happens to the verification afterwards: a reset, an expiry or a purge takes none away. A person who reaches a gate check again with nothing it reads changed is not asked again, so makes no new stop.
Narrow it to a period with from and to. Those are read against the day each stop was made, whenever the verification behind it was created.
This is not gated in the verification summary, which counts the verifications standing in that status now, by the day each was created. Sending the person back does not make a verification gated: it stays open, and how it ends decides whether it uses a credit.
curl --request GET \
--url https://api.verify.privue.ai/verifications/gate-stops \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.verify.privue.ai/verifications/gate-stops"
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/verifications/gate-stops', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"stops": 8,
"workflows": [
{
"workflow_key": "merchant-onboarding",
"stops": 6,
"gates": [
{
"step_key": "already-a-dealer",
"stops": 4,
"gated": 1,
"sent_back": 3
},
{
"step_key": "gst-onboarded",
"stops": 2,
"gated": 2,
"sent_back": 0
}
]
},
{
"workflow_key": "vendor-verification",
"stops": 2,
"gates": [
{
"step_key": "gst-onboarded",
"stops": 2,
"gated": 1,
"sent_back": 1
}
]
}
]
}{
"code": "unauthenticated",
"detail": "Missing or malformed Authorization header"
}{
"code": "client-not-enrolled",
"detail": "no active verification client 4b8f21c6-59ad-4a70-9e11-7c3d0a52f8b4"
}{
"code": "window-invalid",
"detail": "from: must not be after to"
}{
"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.
Query Parameters
First day to include, in IST, inclusive.
Last day to include, in IST, inclusive.
Response
Every stop your gate checks made, in total, per workflow and per gate check.
The stops your gate checks made, in total and per workflow.
