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

Truist Retail Oauth Authentication

Set up consent authorization tokens to access a client's Truist account data. OAuth API Truist publishes an OpenAPI 3.1.0 contract (v3.3.0) for this product on the Truist Developer Center.

Truist Retail Oauth Authentication 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 22 schemas. It is described by OpenAPI 3.1.0, at version 3.3.0.

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

2 operations 2 paths 22 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.3.0
Base URL
https://api.truist.com/retail/auth/oauth
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Truist Retail Oauth Authentication declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 4 scopes. By default, every request must be authenticated.

  • BasicAuth — This is the standard Basic Auth scheme encoded as Base64(clientid:clientsecret). Both Data Access Platforms and Direct Data Recipients MUST use the DAP/DDR cli…
  • OAuth — The production authorization URL will be provided after the onboarding process is completed.

Paths & Operations 2

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

OAuth 2.0 2

OAuth 2.0 authorize and token services

GET
/v3/authorize
Get authorization from the resource owner
authorize 8 params → 302400401
POST
/v3/token
Get an access token
token 2 params body → 200400401404405

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are TokenResponse (8 properties), TokenRequest (6 properties), Error (2 properties), APIErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ActorType
string
Indicates whether a customer is present and has requested the operation (USER), or if a batch job has requested the operation (BATCH)
APIErrorResponse
object
2 properties 1 required
Error
object
2 properties 2 required
TokenRequest
object
6 properties 3 required
TokenResponse
object
8 properties
Scope
string
The enum values of defined scopes. Scope offlineaccess must be included to get back refreshtokens
302RedirectURI
string
Success Response
302MissingState
string
The request is missing a required parameter: state
302MissingResponseType
string
Missing response type
302UnsupportedResponseType
string
The authorization server does not support obtaining an authorization code using this method
302MissingScope
string
The request is missing a required parameter: scope
302InvalidScope
string
The requested scope is invalid, unknown, or malformed
302MissingValidScope
string
The requested scopes are not valid for data recipient
302MissingNonce
string
The request is missing a required parameter: nonce
302ServerError
string
The authorization server encountered an unexpected condition that prevented it from fulfilling the request
302Unavailable
string
The authorization server is currently unable to handle the request
302RequestNotSupported
string
The request parameter is not supported
302RequestURINotSupported
string
The requesturi parameter is not supported
302RegistrationNotSupported
string
The registration parameter is not supported
302UserDenied
string
The user denied the request
302InvalidCardinality
string
The requested cardinality is unknown, use SINGLE or MULTIPLE
302AccountTypesNotSupported
string
None of the requested accountTypes are supported

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bbandt-corp-retail-auth-oauth-openapi.yml Raw ↑

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

Truist Commercial Accounts
Truist Commercial Account Balance
Truist Commercial Account Transactions
Truist Personal and Small Business Accounts
Truist Branch/ATM Locator
Truist Personal and Small Business Transactions
Truist Personal and Small Business Client Contact
Truist User Consent
Truist Retail Dynamic Client Registration
Truist Personal and Small Business Account Payment Networks
Truist Account Address
Truist Credit Transfers
Where this information came from

This is an independent, third-party profile of Truist Retail Oauth Authentication, 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.