A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "cv_3d81",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2b6f",
"method": "dob_postcode",
"requiredFields": [
"dob",
"postcode"
],
"verifierSkillId": "skl_verify_identity",
"tokenTtlSeconds": 900,
"maxAttempts": 3,
"stepUpFor": [
"refund",
"change_address"
]
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Replace caller verification settings
Replaces the agent’s full set of caller-verification configurations with the list you send. This is a full overwrite, so include every configuration you want to keep; any one you omit is removed.
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"id": "cv_3d81",
"agentId": "agt_4f9c2b7e10a24d51",
"organizationId": "org_2b6f",
"method": "dob_postcode",
"requiredFields": [
"dob",
"postcode"
],
"verifierSkillId": "skl_verify_identity",
"tokenTtlSeconds": 900,
"maxAttempts": 3,
"stepUpFor": [
"refund",
"change_address"
]
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
- Token URL
- /api/v1/api-keys
Path Parameters
The agent this resource is scoped to (the UUID returned by createAgent / listAgents).
Body
Server-assigned config id.
The agent this config is scoped to.
The owning organization (server-set).
The verification challenge: dob_postcode — match date-of-birth + postal code; otp_sms — one-time passcode texted to the caller's number; account_pin — a numeric PIN on the account record; knowledge_based — knowledge-based questions (e.g. last transaction amount).
dob_postcode, otp_sms, account_pin, knowledge_based The id of the skill that performs the actual lookup/challenge. Must exist on the agent.
The identity fields the caller must supply to pass, matched against the account record (e.g. ["dob","postcode"] for dob_postcode, ["pin"] for account_pin).
How long a passed verification stays valid within the conversation, in seconds (e.g. 900).
Maximum challenge attempts before the caller is locked out for this conversation (e.g. 3).
Actions/fields that force a re-verification (step-up) even if already verified — e.g. ["refund","change_address"] for high-risk operations.