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
Mastercard

Mastercard Users API

The Users API from Mastercard — 21 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include User. 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 25 operations across 15 paths, and defines 96 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 12 base URLs: https://mtf.api.identity.mastercard.co.in/aes, https://mtf.api.identity.mastercard.com/aes, https://api.identity.mastercard.co.in/aes, https://api.identity.mastercard.com/aes, https://api.mastercard.com/idservice, https://sandbox.api.mastercard.com/idservice, https://api.mastercard.com.au/idservice, https://sandbox.api.mastercard.com.au/idservice, https://apiedge.mastercard.com/commercial, https://mtf.apiedge.mastercard.com/commercial, https://sandbox.api.mastercard.com/loyalty/mrs, https://api.mastercard.com/loyalty/mrs.

25 operations 15 paths 96 schemas 5 DELETE6 GET10 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 25

Across 15 paths, the API surfaces 25 operations — 5 DELETE, 6 GET, 10 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 25
DELETE
/user-consents/{user_consent_id}
Revoke user consent using an identifier
revokeUserConsentById 1 param → 204400401404
GET
/user-consents/{user_consent_id}
Retrieve user consent by an identifier
getUserConsentById 1 param → 200400401404
POST
/user-profiles/identity-searches
View an Identity
retrieveIdentities 2 params body → 200400401403404
POST
/user-profiles
Create a new user
createUserProfile body → 201400
DELETE
/user-profiles
Delete an Identity
deleteUserProfile 2 params → 200400401403404
POST
/user-profiles/identity-attribute-deletions
Delete Document
deleteIdentityAttribute 2 params body → 200400401403404
POST
/user-account-activity-searches
View identity lifecycle activities which have occurred in a time period
retrieveUserActivities 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…
extractClaimsUserData 1 param body → 200400404
POST
/claims/user-consents
Share an Identity with an External RP - Provide consent to share the identity…
getUserConsentStatus body → 200400404
POST
/users
Register a new user
Users body → 201400401403404
PUT
/users
Updates personal information for currently enrolled users (cardholders)…
updateUser body → 200400
GET
/users/{user_guid}/virtual-card-accounts
Retrieve a list of all virtual cards linked to a user
findVcnCardsByUser 1 param → 200400401403404
POST
/users/{user_guid}/virtual-card-accounts
Register a virtual card linked to a user
createVirtualCardWithControls 1 param body → 201400401403404
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}
Retrieve virtual card account details linked to a user
findVcnCardByUser 2 params → 200400401403404
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}
Update virtual card account details linked to a user
updateUserCardAndControls 2 params body → 200400401403404
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}
Delete a virtual card account linked to a user
deleteUserVirtualCard 2 params → 204400401403404
GET
/users/{user_guid}
Retrieve user details
getUserById 1 param → 200400401403404
PUT
/users/{user_guid}
Update a user
updateUserById 1 param body → 200400401403404
DELETE
/users/{user_guid}
Delete a user
deleteUser 1 param → 204400401403404
POST
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens
Register a token linked to a user and a virtual card
TokenCreate 2 params body → 201400401403404
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Retrieve token details linked to a user and a virtual card
getTokenById 3 params → 200400401403404
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Update a token linked to a user and a virtual card
updateTokenById 3 params body → 200400401403404
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Delete a token linked to a user and a virtual card
deleteTokenById 3 params → 204400401403404
POST
/users/{id}/verifications
Verifies user
verifyUser 2 params body → 200400
GET
/users/{id}
Retrieves a cardholder's information, including their name, address…
getUser 4 params → 200400

Schemas 96

The contract defines 96 schemas that model the data the API accepts and returns. The most detailed are UserUpdate (42 properties), UserDetails (33 properties), UserEnroll (27 properties), AccountBase (23 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property 1 required
Error
object
5 properties 3 required
Errors
array
UserConsent
object
The user consent resource
3 properties 3 required
GovtIdImage
RPClaimsUserData
object
6 properties 4 required
LegalName
object
2 properties 2 required
CountryCode
string
The country code of the country where the transaction originates from.
UserAccountActivitySearch
object
5 properties 4 required
Address
1 required
Scopes
object
An object that represents a list of requested scopes and values.
2 properties
IdentityAttributesByName
object
Identity attributes keyed by IdentitySearch.scopedFields enum.
Phone
object
2 properties 2 required
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…
UserAccountActivityItemContents
object
4 properties 1 required
Cpf
string
CPF Number. This will only be available when the Brazilian DL is scanned.
FathersName
object
2 properties 2 required
IdentityAttributeDeleted
object
1 property 1 required
RPClaimsUserConsentData
object
4 properties 4 required
UserProfile
object
6 properties 2 required
DriverLicenseIdentity
object
3 properties
DriverLicenseCardNumber
string
Document number.
PassportImage
object
Passport License Images.
1 property
UserAccountActivities
object
2 properties 1 required
Cnh
DriverLicenseDetails
object
3 properties
IdentityAttributeDeletions
object
7 properties 4 required
AuditEventsItem
object
12 properties
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…
IdentityAttributesById
object
Identity attributes are keyed by attribute IDs.
VisaMatched
boolean
Flag indicating if the documentDetails are to be checked against a visa for a particular country.
DriverLicenseImage
object
Driver License Images.
2 properties
GovtId
TpAuditMetadata
object
Object containing metadata related to the request.
2 properties 2 required
Selfie
object
2 properties 2 required
IdentitySearch
object
4 properties 3 required
ClientIdentities
object
2 properties 1 required
UserConsent_2
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…
Rg
string
RG Number. This will only be available when the Brazilian DL is scanned.
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".
AddressData
object
6 properties
GovtIdDetails
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…
IdentityAttribute
Email
object
2 properties 2 required
MothersName
object
2 properties 2 required
DateOfBirth
object
2 properties 2 required
ErrorResponse_2
object
The error response model used by all the API endpoints.
1 property 1 required
RPClaimsUserConsent
object
8 properties 3 required
PassportIdentity
object
3 properties
UserAccountActivityItems
object
3 properties 2 required
RPClaimsUserDetails
object
7 properties 2 required
ClaimsData
object
2 properties
MobileIdEligibility
object
2 properties 2 required
PassportDetails
object
3 properties
Vcn
ErrorList
array
UserDetail
object
4 properties 4 required
VcnUserDetail
object
3 properties 3 required
ResourceIdentifier
string
A UUID which uniquely identifies a resource
UpdateVirtualCardAccount
object
1 required
VirtualCardAccount
object
2 required
AmountRangeControl
object
The exact amount range control will approve a transaction only if the requested amount is equal or greater than MinAmount and less than or equal to MaxAmount.…
6 properties 4 required
Error_2
object
5 properties
Errors_2
object
1 property 1 required
Card
object
2 properties 2 required
ValidityPeriodControl
object
The ValidityPeriod control provides the ability to limit authorization activity to a defined time period
4 properties 3 required
Control
object
In Control Rule
12 properties 2 required
TimeOfDay
object
3 properties 3 required
Token
object
4 properties
TokenUpdate
object
1 property
MerchantIdControl
object
The Merchant ID control provides the ability to limit authorizations to particular merchants
3 properties 3 required
VelocityControl
object
The VelocityControl can limit the frequency, and the total cumulative amount of authorizations performed on the cardholders account within a specified time per…
8 properties 2 required
MccControl
object
The Card Acceptor Business Codes (MCC) control can control the type of purchases for which a card is used
2 properties 2 required
UpdateVCN
object
2 properties
TransactionLimitControl
object
The TransactionLimit control provides the ability to limit individual transaction authorizations to a maximum amount
2 properties 2 required
ErrorWrapper
object
1 property 1 required
GeographyControl
object
The GeographicControl provides the ability to control where a card is physically used
2 properties 2 required
AgeingVelocityControl
object
The AgingVelocityControl provides the requester with the ability to set a notional credit line through the CumulativeControl. This control keeps track of the c…
7 properties 4 required
Controls
array
In Control Card Controls
TimeOfDayControl
object
The TimeOfDayControl provides the ability to limit authorization activity to defined time periods for each day
3 properties 3 required
CurfewControl
object
Curfew Control
5 properties 4 required
UserDetails
object
33 properties
EnrolledUser
object
4 properties
UserVerificationDetails
object
2 properties
AccountBase
object
This object will define the users initial account that is being enrolled at the same time as the user.
23 properties 5 required
ErrorsWrapper
object
1 property 1 required
ErrorItem
object
Error Details
5 properties
UserUpdate
object
42 properties 2 required
Errors_3
object
1 property 1 required
PCLOUser
object
This object should only be used by Personal Card Linked Offers (PCLO) users. This object will define the users communications preferences for PCLO.
3 properties
UserAddress
object
This object will define the users default shipping/mailing address.
8 properties
VerificationDetails
object
3 properties
VerifyUser
object
1 property 1 required
UserEnroll
object
27 properties 4 required
VerifiedUser
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mastercard-users-api-openapi.yml Raw ↑

Other APIs Mastercard publishes across the network.

Mastercard Universal Specification Submission API
AE Profile APIs.io
Mastercard Account to Account Commerce for Creditor Service Providers
AE Profile APIs.io
Mastercard Debtor Service Provider Resources API
AE Profile APIs.io
Mastercard Automatic Billing Updater API
AE Profile APIs.io
Mastercard Benefit Eligibility Service API
AE Profile APIs.io
Mastercard Bill Pay API
AE Profile APIs.io
Mastercard Bill Payment Validator
AE Profile APIs.io
Mastercard BIN Lookup API
AE Profile APIs.io
Mastercard Business Payment Controls
AE Profile APIs.io
Mastercard Carbon Calculator API
AE Profile APIs.io
Mastercard Carbon Calculator Experience API
AE Profile APIs.io
Mastercard Checkout Solutions
AE Profile APIs.io
#User
← Back to M APIs
API Details
ID
mastercard:mastercard-users-api
Base URL
https://api.example.com
Docs
https://developer.mastercard.com/product/account-services-catalogue/
Provider
Mastercard
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=mastercard-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mastercard-users-api"

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 Mastercard Users 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.