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

Barclays Apply Product External API OAS API

Apply Product External API

Barclays Apply Product External API OAS API is one of 64 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include applyProductExternalAPI-OAS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 9 paths, and defines 65 schemas. It is described by OpenAPI 3.2.0, at version 4.0.

Requests are made against the base URL https://telesto.api.barclays/open-banking/v3.1.

9 operations 9 paths 65 schemas 1 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0
Base URL
https://telesto.api.barclays/open-banking/v3.1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Barclays Apply Product External API OAS API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ExternalTiaaUsCCAuth) using the clientCredentials flow, exposing 2 scopes.

  • ExternalTiaaUsCCAuth — OAuth2.0 Client Credentials Grant authentication using TIAA-US for external APIs

Paths & Operations 9

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

applyProductExternalAPI-OAS 9

Apply Product External API

POST
/cards/prequal
Pre Qualification Check.Please use Content-Type as application/jose for…
postRequestForPrequalDecision 3 params body → 200400401500403404503
POST
/cards/applications/verify
Process the application post challenge verification
postApiForApplicationVerification 3 params body → 200400401500403404503
POST
/cards/prescreen/{prescreenId}/capture
Capture the fact that the offer(s) were displayed to the customer
postApiForPrescreenOffersCapture 4 params body → 200400401500403404503
POST
/cards/prescreen
Get all eligible offers for a customer.
postApiForPrescreenOffer 3 params body → 200400401500403404503
POST
/cards/accounts/instant-credit
Get card details based on the accountId.
postApiForInstantCreditCardDetail 3 params body → 200400401500403404503
POST
/cards/app-consent
The API accepts consent from Applicant for various capabilities.
postApiForAppConsent 3 params body → 200400401500403404503
POST
/cards/applications
Apply for the credit card and get status, T&C and CMA.
applyPostOperation 3 params body → 200400401500403404503
GET
/cards/applications/{applicationId}
Get the status of application
getApiForApplicationStatus 4 params → 200400401500403404503
POST
/cards/offer
Accepts meta data to fetch a unique offerId
postApiForOffer 3 params body → 200400401500403503

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are ApplicationReqAttributes (29 properties), ApplicationRequest (14 properties), ApplicationResAttributes (14 properties), ApplicationConsentResponseAttributes (11 properties). Each schema is shown below with its type and property counts.

ApplicationConsentResponse
object
App consent response data
1 property 1 required
DeviceProfiling
array
List of DeviceProfiling
ErrorType
object
Message details - additional operation execution information.
5 properties 3 required
ApplicationStatusResponse
object
Application status for applicant
1 property 1 required
AdditionalAttributes
array
Any additional attributes that needs to be sent with the request
PrescreenOffersResponse
object
The best offer for which Prospect customer is eligible for
1 property 1 required
ApplicationVerificationRequest
object
Verification request data
1 property 1 required
PartnerAttributes_1
array
Partner specific custom attributes
ApplicationReqAttributes_secondaryApplicants
object
Secondary applicant details
4 properties
DeviceVerificationContextAttributes
object
Device verification attributes
2 properties 2 required
PrescreenOffersRequest
object
Prescreen a customer against an existing offer
1 property 1 required
OccupationEnum
string
Occupation types
OfferAttributes
array
InstantCreditByAccountReqAttributes
object
Instant Credit look up account id request attributes
3 properties 1 required
DownsellProductInfoAttributes
object
Downsell Product information will be sent in the response for the application status 'DOWNSELLAPPROVEDCONSENTREQUIRED' and 'DOWNSELLPENDEDCONSENTREQUIRED'.In c…
3 properties
OfferReqAttributes
object
Offer Request Attributes
10 properties 6 required
BalanceTransfersAttributes
object
Balance transfer requests
2 properties 2 required
ApplicationRes
object
Application response data
1 property 1 required
PrescreenOffersCaptureRequest
object
Prescreen offer capture request
1 property 1 required
NameValueAttributePair
object
Name value attributes
2 properties 2 required
ApplicationReqAttributes
object
Application Request Attributes
29 properties 10 required
BalanceTransfersAttributeList
array
Balance transfers with respect to application request
InstantCreditByAccountRequest
object
InstantCredit look up by accountId API request
1 property 1 required
ApplicationRequest
object
Prequal a customer against for an given offer
14 properties 3 required
PrescreenOffersCaptureResponseAttributes
object
Prescreen offer capture response
1 property 1 required
PrequalDecision
object
Decision object
6 properties
PrescreenOffersCaptureResponse
object
Prescreen offer capture response
1 property 1 required
ApplicationVerificationResponseAttributes
object
response
11 properties 1 required
ValidationError
object
Validation Errors
3 properties
PrescreenOffersRequestAttributes
object
Prescreen a customer against an existing offer
7 properties 3 required
ApplicationConsentResponseAttributes
object
Application Consent Response Attributes
11 properties 1 required
Address
object
Permanent address Info
5 properties 4 required
ErrorResponseType
object
An API error response.
2 properties
ApplicationVerificationRequestAttributes
object
Verification Request Attributes
2 properties 2 required
CreditBureauDetails
object
Offer Object
3 properties
InstantCreditByAccountResponse
object
InstantCredit look up by accountId API response
1 property 1 required
ApplicationVerificationResponse
object
Verification response data
1 property 1 required
InstantCreditByAccountResAttributes
object
response
2 properties 1 required
CardDetailAttributes
object
response
5 properties
PartnerAttributes_2
array
Partner specific custom attributes
ApplicationStatusResponseAttributes
object
Application status for applicant
8 properties 3 required
Offer
object
Offer Object
11 properties
ApplicationConsentRequestAttributes
object
Application Consent Request Attributes
4 properties 3 required
OfferResponse
object
Offer API response
1 property 1 required
PrequalRes
object
Decision response for the customer prequal submission
3 properties
ApplicationConsentRequest
object
App consent request data
1 property 1 required
PartnerDataAttributes_1
array
List of partner data attributes
StateEnums
string
Applicant's State
TrackingAttributeList
array
Tracking attribute list with respect to application request
PrescreenOffersCaptureRequestAttributes
object
Prescreen offer capture request
1 property 1 required
ProductDataAttributes
array
Product data attribute list with respect to application request
PrescreenOffersResponseAttributes
object
The best offer for which Prospect customer is eligible for
9 properties 4 required
PartnerAttributes
array
Partner specific custom attributes
TokenAttributes
object
response
3 properties
OfferResAttributes
object
response
4 properties 1 required
ApplicationReq
object
Application Request Attributes
1 property 1 required
ApplicationResAttributes
object
response
14 properties 1 required
CardNumberAttributes
object
response
3 properties
OfferRequest
object
Offer API request
1 property 1 required
PrequalRequestAttributes
object
PrequalRequestAttributes object
4 properties
Attributes
array
PrequalResponse
object
Prequal decision response From apply screening
1 property 1 required
PartnerDataAttributes
array
Partner Data attribute list with respect to application request
PrequalRequest
object
Prequal decision request for the customer
1 property 1 required
TrackingInfo
array
List of tracking information

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-applyproductexternalapi-oas-api-openapi.yml Raw ↑

Other APIs Barclays publishes across the network.

Barclays Smartpay Web Payment API
Barclaycard Smartpay Connect API
Barclays Corporate Payment Initiation API
Barclays Balances and Transactions Reporting API
Barclays Account Access Consents API
Barclays Accounts API
Barclays Atms API
Barclays Balances API
Barclays Beneficiaries API
Barclays Branches API
Barclays Business Current Accounts API
Barclays Card Account Details Inquiry External API
Where this information came from

This is an independent, third-party profile of Barclays Apply Product External API OAS 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.