List call flags by task type
curl --request GET \
--url https://api.finosu.com/calls/flags \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.finosu.com/calls/flags"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.finosu.com/calls/flags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/calls/flags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/calls/flags"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.finosu.com/calls/flags")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/calls/flags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"name": "ADVERSE_ACTION_NOAA",
"description": "A notice of adverse action was identified during the call."
},
{
"name": "ATTORNEY_REP",
"description": "The customer reports being represented by an attorney."
},
{
"name": "BANKRUPTCY",
"description": "The customer reports having filed for bankruptcy."
},
{
"name": "COMPLAINT_TRIGGER_PHRASE",
"description": "The customer expressed a complaint that requires follow-up."
},
{
"name": "DEBT_CONSOLIDATION",
"description": "The customer reports working with a debt consolidation or debt management company."
},
{
"name": "DECEASED",
"description": "The call indicates that the customer is deceased."
},
{
"name": "DNC",
"description": "The customer requested that calls stop."
},
{
"name": "INCARCERATED",
"description": "The call indicates that the customer is incarcerated."
},
{
"name": "MILITARY",
"description": "The call identifies the customer's military status or related protections."
},
{
"name": "WITHDRAWAL",
"description": "The customer requests to withdraw their loan application."
},
{
"name": "WRONG_NUMBER",
"description": "The dialed number does not belong to the intended customer."
}
]
Calls
List Call Flags
Returns the approved public integration flags for the requested task type: 11 for PendingLoanNewLead or PendingLoanReturning, and 14 for Collections. The static catalog is identical for every authenticated company, ordered alphabetically, and has no pagination. This lookup does not enable workflows, configure webhook delivery, or cancel servicing.
GET
/
calls
/
flags
List call flags by task type
curl --request GET \
--url https://api.finosu.com/calls/flags \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.finosu.com/calls/flags"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.finosu.com/calls/flags', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.finosu.com/calls/flags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.finosu.com/calls/flags"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.finosu.com/calls/flags")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.finosu.com/calls/flags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"name": "ADVERSE_ACTION_NOAA",
"description": "A notice of adverse action was identified during the call."
},
{
"name": "ATTORNEY_REP",
"description": "The customer reports being represented by an attorney."
},
{
"name": "BANKRUPTCY",
"description": "The customer reports having filed for bankruptcy."
},
{
"name": "COMPLAINT_TRIGGER_PHRASE",
"description": "The customer expressed a complaint that requires follow-up."
},
{
"name": "DEBT_CONSOLIDATION",
"description": "The customer reports working with a debt consolidation or debt management company."
},
{
"name": "DECEASED",
"description": "The call indicates that the customer is deceased."
},
{
"name": "DNC",
"description": "The customer requested that calls stop."
},
{
"name": "INCARCERATED",
"description": "The call indicates that the customer is incarcerated."
},
{
"name": "MILITARY",
"description": "The call identifies the customer's military status or related protections."
},
{
"name": "WITHDRAWAL",
"description": "The customer requests to withdraw their loan application."
},
{
"name": "WRONG_NUMBER",
"description": "The dialed number does not belong to the intended customer."
}
]
Retrieve the approved public call flags for a task type. Use the returned names
and descriptions to populate your integration’s event configuration without
hardcoding flag codes on your side.
These are the values published by List Origination Task Types
and List Collections Task Types.
Both origination types return exactly the same catalog. For each task type, the
catalog is identical for all authenticated companies. It does not indicate whether
a workflow is enabled for your account.
Authentication errors contain a string
Request
curl --request GET 'https://api.finosu.com/calls/flags?taskType=PendingLoanNewLead' \
--header 'X-API-Key: YOUR_API_KEY'
taskType is required and case-sensitive:
| Task type | Workflow | Flags |
|---|---|---|
PendingLoanNewLead | Origination for new applications | 11 |
PendingLoanReturning | Origination for returning borrowers | 11 |
Collections | Collections | 14 |
Response
HTTP200 returns an array of {name, description} objects, ordered alphabetically
by name, with no pagination. name is the case-sensitive flag code to use in
configuration; description explains its meaning for your UI. The OpenAPI examples
show the complete current catalogs.
This is a deliberately selected public catalog. It is not an exhaustive inventory
of every flag that may appear in call results. Use codes as identifiers and display
descriptions as text. Retrieve the catalog when loading configuration; it does not
need to be fetched after every call. Successful responses use
Cache-Control: private, max-age=3600: private clients may reuse the response for
one hour, while shared caches must not store it. Cache each taskType URL
separately and refresh after expiry. Clients that do not implement HTTP caching
must explicitly implement reuse; the header alone does not prevent requests.
Catalog updates can take up to one hour to appear in a fresh client cache.
Requests reaching the API still require a valid API key.
Available flags
In this table, Origination applies to bothPendingLoanNewLead and
PendingLoanReturning.
| Flag | Description | Origination | Collections |
|---|---|---|---|
ADVERSE_ACTION_NOAA | A notice of adverse action was identified during the call. | Yes | Yes |
ATTORNEY_REP | The customer reports being represented by an attorney. | Yes | Yes |
BANKRUPTCY | The customer reports having filed for bankruptcy. | Yes | Yes |
COERCED_DEBT | The customer reports that the debt was incurred through coercion. | — | Yes |
COMPLAINT_TRIGGER_PHRASE | The customer expressed a complaint that requires follow-up. | Yes | Yes |
DEBT_CONSOLIDATION | The customer reports working with a debt consolidation or debt management company. | Yes | Yes |
DEBT_DISPUTE | The customer disputes the debt or account. | — | Yes |
DECEASED | The call indicates that the customer is deceased. | Yes | Yes |
DNC | The customer requested that calls stop. | Yes | Yes |
FRAUD_CLAIM | The customer reports suspected fraud involving the account. | — | Yes |
HARDSHIP_REQUEST | The customer requests payment assistance or accommodation due to hardship. | — | Yes |
INCARCERATED | The call indicates that the customer is incarcerated. | Yes | Yes |
MILITARY | The call identifies the customer’s military status or related protections. | Yes | Yes |
WITHDRAWAL | The customer requests to withdraw their loan application. | Yes | — |
WRONG_NUMBER | The dialed number does not belong to the intended customer. | Yes | Yes |
Configuring actions
Your integration decides which action to associate with each returned flag. For cancellation actions, retrieve the available reasons from List Stop Servicing Reasons. A flag code and a stop-servicing reason are separate values; do not assume their names match or that every flag requires cancellation. This endpoint provides definitions only. It does not deliver events, configure webhook URLs or credentials, or cancel servicing. Coordinate call-result delivery with your existing integration setup.Errors
| Status | Meaning |
|---|---|
401 | API key is missing, empty, invalid, inactive, or deleted |
422 | taskType is missing or is not one of the supported values |
detail. Query validation errors contain
an array of errors in detail, including each error’s loc, msg, and type.Authorizations
Query Parameters
Case-sensitive task type from the origination or collections task-type catalog.
Available options:
PendingLoanNewLead, PendingLoanReturning, Collections