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

BB&T Corp (Truist) User Consent API

Request a customer consent grant

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

Tagged areas include User Consent. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.2.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.2.0
API Version
1.1.0
Base URL
https://api.truist.com/commercial
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

BB&T Corp (Truist) User Consent API 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.

ConsentRevocationRequest
object
Details of request to revoke consent grant
2 properties 2 required
ConsentGrantResource
object
Entity of permissioned resources
3 properties 3 required
DataCluster
string
Name of permissioned [cluster of data elements](https://fdx.atlassian.net/wiki/spaces/FDX/pages/872906996/v1.1+Data+Clusters)
Party
object
FDX Participant - an entity or person that is a part of a FDX API transaction
7 properties 2 required
LookbackPeriod
integer
Period, in days, for which historical data may be requested; period is measured from request time, not grant time
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)
ConsentDurationType
string
Duration of the Consent Grant, per FDX UX Guidelines v1.0 (pp 18 - 20)
Registry
string
Identifies the type of a Registry
Identifier
string
Value for a unique identifier
ConsentDurationPeriod
integer
Consent duration, in days, from day of original grant
FapiInteractionId
string
Universally unique identifier for this interaction, used across all FDX API requests and responses
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
PartyType
string
Identifies the type of a party
ConsentUpdateReason
string
Reason for Updating a Consent Grant
ConsentGrantStatus
string
Current status of Consent Grant
ConsentId
Unique ID for a consent grant
ConsentGrant
object
Record of user consent
11 properties
Error
object
An error entity which can be used at the API level for error responses
2 properties
ConsentResourceType
string
Resource for which data may be permissioned; can be extended to support additional types of resources

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bbandt-corp-user-consent-api-openapi.yml Raw ↑

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

BB&T Corp (Truist) Account Information API
BB&T Corp (Truist) Account Transactions API
BB&T Corp (Truist) Commercial Account Balance API
BB&T Corp (Truist) Commercial Account Transactions API
BB&T Corp (Truist) Commercial Accounts API
BB&T Corp (Truist) Credit Transfers Account List API
BB&T Corp (Truist) Credit Transfers Acknowledge API
BB&T Corp (Truist) Credit Transfers API
BB&T Corp (Truist) Credit Transfers Approval/Reject API
BB&T Corp (Truist) Event Notification Subscriptions API
BB&T Corp (Truist) Event Notifications API
BB&T Corp (Truist) Location Information API
Where this information came from

This is an independent, third-party profile of BB&T Corp (Truist) User Consent API, 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.