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

Mastercard Data API

The Data API from Mastercard — 8 operation(s) for data.

Mastercard Data API is one of 249 APIs that Mastercard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, a changelog, a support channel, and a getting-started guide.

This API exposes 9 operations across 8 paths, and defines 46 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://api.example.com.

9 operations 8 paths 46 schemas 1 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://api.example.com
Resource Areas
1

Paths & Operations 9

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

Data 9
POST
/user-data-tokens
Mastercard Create a User Data Token Which Is Used in the Redirection Url That Redirects the Cardholder to the Website for Submitting a New Claim.
createUserToken body → 200400401
POST
/tp-data-shares
Add an Independently Validated Phone Number.
updatePdsData 2 params body → 200400401403404
POST
/document-verifications/document-data-retrievals
Retrieve the details of a document.
retrieveDocumentData 1 param body → 200400403404
PUT
/document-verifications/document-data-retrievals
Add and Validate a Document - Retrieve the details of an additional document.
retrieveMultiDocumentData 2 params body → 200400403404
POST
/document-verifications/document-data-confirmations
Add and Validate a Document - Confirm the details of a document.
confirmDocumentData 2 params body → 200400401403404
POST
/claims/user-data-extractions
Share an Identity with an External RP - Provide the PDS to enable ID for TP to determine if these satisfy an RPs scope request.
extractClaimsUserData 1 param body → 200400404
POST
/data-extractions/access-tokens
The provider token is retrieved by country code and SDK version
retrieveDataExtractionAccessToken 1 param body → 200400
POST
/data-extractions/facematch
Verifies the details of a selfie with an identity verification provider
facematchVerification 1 param body → 200400403
GET
/data-extractions/scans/{scan_id}
Returns the status of the document verification.
extractScannedDocumentData 8 params → 200400403404

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are DocumentVerificationExtractedDataDocumentData (29 properties), AuditEventsItem (12 properties), DocumentDataRetrieval (12 properties), DocumentVerificationConfirmData (12 properties). Each schema is shown below with its type and property counts.

SubmitClaimUserToken
object
1 property
ErrorItem
object
5 properties
SubmitClaimUserData
object
11 properties 1 required
ErrorItems
object
1 property 1 required
TpAuditMetadata
object
Object containing metadata related to the request.
2 properties 2 required
Locale
string
IETF BCP 47 code which identifies the language to be used in any dialogs being shown to the user during the flow. The default value is "en-US".
ConfirmedPDS
object
4 properties 2 required
AddressData
object
6 properties
DocumentDataStatus
Object containing the details of the document whose accuracy has been confirmed by the user.
10 required
DocumentVerificationConfirmData
object
12 properties 5 required
BaseEvidenceData
object
9 properties
PDS
string
Encrypted Personal Device Storage (PDS) which hosts the users identity attributes. The PDS can be retrieved from the MIDS Core SDK, please refer to the SDK gui…
RPClaimsUserData
object
6 properties 4 required
FraudDetection
object
Object containing the signals from the device to be used for fraud detection.
1 property
DocumentData
Object containing the details of the document whose accuracy has been confirmed by the user.
10 required
Phone
object
2 properties 2 required
RPClaimsUserDetails
object
7 properties 2 required
ErrorResponse
object
The error response model used by all the API endpoints.
1 property 1 required
TPDataShareSuccessData
object
1 property
AuditEventsItem
object
12 properties
SdkVersion
string
Mastercard SDK version integrated with TP App, it is a constant extracted from MIDS SDK Configurations (generated while bundling SDK artifacts). If the TP app…
DocumentDataRetrieval
object
12 properties 7 required
UserConsent
string
Confirmation provided by the TP that the user has consented that the ID-Network can have access to their identity for the purposes of the API call. Should be A…
TpDataShare
object
6 properties 3 required
MultiDocumentDataRetrieval
6 required
DocumentVerificationExtractedData
object
3 properties 2 required
Email
object
2 properties 2 required
ARID
string
A unique identifier for any activity being executed arising out of a Claim Share request. This value is passed as a parameter in the URL redirecting a User to…
FraudDetectionMetaRequiredItem
object
An item that is required from fraud detection meta.
2 properties
ClaimsData
object
2 properties
DeviceInfo
object
Object containing the details of the device from which the enrollment is being conducted.
3 properties 3 required
FraudDetectionMeta
object
Fraud detection meta-data.
1 property
Scopes
object
An object that represents a list of requested scopes and values.
2 properties
CountryCode
string
The country code of the country where the transaction originates from.
Address
1 required
ConfirmDocumentData
Document data to be verified.
8 required
ApiError
object
1 property 1 required
SelfieVerificationRequest
object
4 properties 4 required
FacematchSourceVerificationResult
object
3 properties 3 required
Error
object
5 properties
AccessToken
object
6 properties 3 required
DocumentVerificationExtractedDataDocumentData
object
Document Data.
29 properties 10 required
DocumentVerificationExtractedData_2
object
3 properties 2 required
RetrieveAccessToken
object
11 properties 2 required
Errors
object
List of Errors.
1 property 1 required
ErrorList
array
Error Details.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-data-api-openapi.yml Raw ↑

Other APIs Mastercard publishes across the network.

Mastercard Universal Specification Submission API
Mastercard Account to Account Commerce for Creditor Service Providers
Mastercard Debtor Service Provider Resources API
Mastercard Automatic Billing Updater API
Mastercard Benefit Eligibility Service API
Mastercard Bill Pay API
Mastercard Bill Payment Validator
Mastercard BIN Lookup API
Mastercard Business Payment Controls
Mastercard Carbon Calculator API
Mastercard Carbon Calculator Experience API
Mastercard Checkout Solutions
Where this information came from

This is an independent, third-party profile of Mastercard Data 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.