How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BB&T Corp (Truist)

Truist User Consent

View or revoke a client's consent. Consent API Truist publishes an OpenAPI 3.1.0 contract (v1.1.0) for this product on the Truist Developer Center.

Documentation Provider Profile APIs.io OpenAPI GitHub

Truist User Consent is one of 15 APIs that BB&T Corp (Truist) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Banking, Personal Banking, Open Banking, and Management. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 1.1.0.

Requests are made against 3 base URLs: https://api-sandbox.truist.com/retail, https://apicert-secure.truist.com/retail, https://api-secure.truist.com/retail.

2 operations 2 paths 19 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.1.0
Base URL
https://api-secure.truist.com/retail
Authentication
HTTP Basic
Contact
Truist API Support
Resource Areas
1

Authentication & Security 1

Truist User Consent declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Base64(clientid:clientsecret)

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Consent 2

Request a customer consent grant

GET
/v1/consents/{consentId}
Get Consent Grant
getConsentGrant 2 params → 200400401404405429500503
PUT
/v1/consents/{consentId}/revocation
Revoke a Consent Grant
revokeConsentGrant 2 params body → 204400401404405429500503

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ConsentGrant (11 properties), Party (7 properties), ConsentGrantResource (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

ConsentGrant
object
Record of user consent
11 properties
ConsentGrantParty
object
Details on the non-end user parties in the Consent Grant. Includes the legal entity operating branded products or services in the data sharing chain. Descripti…
4 required
ConsentGrantResource
object
Entity of permissioned resources
3 properties 3 required
ConsentRevocationRequest
object
Details of request to revoke consent grant
2 properties 2 required
ConsentDurationPeriod
integer
Consent duration, in days, from day of original grant
ConsentGrantStatus
string
Current status of Consent Grant
ConsentId
Unique ID for a consent grant
ConsentResourceType
string
Resource for which data may be permissioned; can be extended to support additional types of resources
ConsentUpdateReason
string
Reason for Updating a Consent Grant
DataCluster
string
Name of permissioned [cluster of data elements](https://fdx.atlassian.net/wiki/spaces/FDX/pages/872906996/v1.1+Data+Clusters)
LookbackPeriod
integer
Period, in days, for which historical data may be requested; period is measured from request time, not grant time
Error
object
An error entity which can be used at the API level for error responses
2 properties
Party
object
FDX Participant - an entity or person that is a part of a FDX API transaction
7 properties 2 required
ConsentDurationType
string
Duration of the Consent Grant, per FDX UX Guidelines v1.0 (pp 18 - 20)
Identifier
string
Value for a unique identifier
PartyType
string
Identifies the type of a party
Timestamp
string
ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to [IETF RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339.htmlsection-5.6)
Registry
string
Identifies the type of a Registry
FapiInteractionId
string
Universally unique identifier for this interaction, used across all FDX API requests and responses

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bbandt-corp-retail-consents-openapi.yml Raw ↑

Other APIs BB&T Corp (Truist) publishes across the network.

Truist Commercial Accounts
AE Profile APIs.io
Truist Commercial Account Balance
AE Profile APIs.io
Truist Commercial Account Transactions
AE Profile APIs.io
Truist Personal and Small Business Accounts
AE Profile APIs.io
Truist Branch/ATM Locator
AE Profile APIs.io
Truist Personal and Small Business Transactions
AE Profile APIs.io
Truist Personal and Small Business Client Contact
AE Profile APIs.io
Truist Retail Oauth Authentication
AE Profile APIs.io
Truist Retail Dynamic Client Registration
AE Profile APIs.io
Truist Personal and Small Business Account Payment Networks
AE Profile APIs.io
Truist Account Address
AE Profile APIs.io
Truist Credit Transfers
AE Profile APIs.io
#Banking#Personal Banking#Open Banking#Management
← Back to T APIs
API Details
ID
bbandt-corp:user-consent
Base URL
https://api-secure.truist.com/retail
Docs
https://developer.truist.com/api/user-consent/overview
Provider
BB&T Corp (Truist)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=user-consent&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/user-consent"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Truist User Consent, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.