Mastercard Users API
The Users API from Mastercard — 21 operation(s) for users.
Mastercard Users API is one of 249 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 31 operations across 21 paths, and defines 116 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://api.example.com.
31 operations
21 paths
116 schemas
5 DELETE8 GET13 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 31
Across 21 paths, the API surfaces 31 operations — 5 DELETE, 8 GET, 13 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Users 31
POST
/user-profiles/identity-searches
View an Identity
POST
/user-profiles
Create a new user.
DELETE
/user-profiles
Delete an Identity.
POST
/user-profiles/identity-attribute-deletions
Delete Document.
POST
/user-account-activity-searches
View identity lifecycle activities which have occurred in a time period.
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.
POST
/claims/user-consents
Share an Identity with an External RP - Provide consent to share the identity attributes which satisfy an RPs scope request.
POST
/users
Register a new user
PUT
/users
Updates personal information for currently enrolled users (cardholders), including their name, contact information, security question, and more.
GET
/users/{user_guid}/virtual-card-accounts
Retrieve a list of all virtual cards linked to a user
POST
/users/{user_guid}/virtual-card-accounts
Register a virtual card linked to a user
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}
Retrieve virtual card account details linked to a user
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}
Update virtual card account details linked to a user
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}
Delete a virtual card account linked to a user
GET
/users/{user_guid}
Retrieve user details
PUT
/users/{user_guid}
Update a user
DELETE
/users/{user_guid}
Delete a user
POST
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens
Register a token linked to a user and a virtual card
GET
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Retrieve token details linked to a user and a virtual card
PUT
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Update a token linked to a user and a virtual card
DELETE
/users/{user_guid}/virtual-card-accounts/{account_guid}/tokens/{token_guid}
Delete a token linked to a user and a virtual card
POST
/users/{id}/verifications
Verifies user
GET
/users/{id}
Retrieves a cardholder's information, including their name, address, communication preferences, and more. Users are unique cardholders, as compared to Accounts that are unique cards. Each User can ha…
DELETE
/user-consents/{user_consent_id}
Revoke user consent using an identifier
GET
/user-consents/{user_consent_id}
Retrieve user consent by an identifier
POST
/issuers/users
Mastercard Allows Issuer to Enroll Cardholders to the Carbon Calculator Experience Platform.
PUT
/issuers/users/{userid}
Mastercard Allows Issuer to Update Enrolled User Information Onto Carbon Calculator Experience Platform.
GET
/issuers/users/{userid}/dashboards
Mastercard Used to Retrieve the Short-lived Url of a User's Dashboard to View Their Carbon Footprints and Contributions to Priceless Planet.
GET
/issuers/users/{userid}/aggregate-carbon-scores
Mastercard Fetches Monthly Aggregate Carbon Score for the Transactions Made for the Current Month.
POST
/issuers/user-deletions
Mastercard Delete One or More Users.
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.
Schemas 116
The contract defines 116 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.
UserAccountActivitySearch
object
5 properties
4 required
RPClaimsUserData
object
6 properties
4 required
UserAccountActivities
object
2 properties
1 required
UserAccountActivityItemContents
object
4 properties
1 required
Cnh
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…
GovtId
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…
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…
IdentityAttribute
RPClaimsUserConsent
object
8 properties
3 required
GovtIdImage
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…
DateOfBirth
object
2 properties
2 required
MothersName
object
2 properties
2 required
PassportIdentity
object
3 properties
ErrorResponse
object
The error response model used by all the API endpoints.
1 property
1 required
IdentityAttributeDeletions
object
7 properties
4 required
AuditEventsItem
object
12 properties
MobileIdEligibility
object
2 properties
2 required
ClaimsData
object
2 properties
Cpf
string
CPF Number. This will only be available when the Brazilian DL is scanned.
Address
1 required
DriverLicenseImage
object
Driver License Images.
2 properties
FathersName
object
2 properties
2 required
PassportImage
object
Passport License Images.
1 property
Selfie
object
2 properties
2 required
UserAccountActivityItems
object
3 properties
2 required
IdentitySearch
object
4 properties
3 required
DriverLicenseDetails
object
3 properties
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.
Rg
string
RG Number. This will only be available when the Brazilian DL is scanned.
LegalName
object
2 properties
2 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".
AddressData
object
6 properties
GovtIdDetails
Phone
object
2 properties
2 required
RPClaimsUserDetails
object
7 properties
2 required
DriverLicenseCardNumber
string
Document number.
IdentityAttributesByName
object
Identity attributes keyed by IdentitySearch.scopedFields enum.
RPClaimsUserConsentData
object
4 properties
4 required
IdentityAttributeDeleted
object
1 property
1 required
Email
object
2 properties
2 required
UserProfile
object
6 properties
2 required
Scopes
object
An object that represents a list of requested scopes and values.
2 properties
ClientIdentities
object
2 properties
1 required
CountryCode
string
The country code of the country where the transaction originates from.
DriverLicenseIdentity
object
3 properties
PassportDetails
object
3 properties
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
CurfewControl
object
Curfew Control
5 properties
4 required
Vcn
Token
object
4 properties
TransactionLimitControl
object
The TransactionLimit control provides the ability to limit individual transaction authorizations to a maximum amount
2 properties
2 required
Error
object
5 properties
UpdateVirtualCardAccount
object
1 required
VirtualCardAccount
object
2 required
MerchantIdControl
object
The Merchant ID control provides the ability to limit authorizations to particular merchants
3 properties
3 required
ResourceIdentifier
string
A UUID which uniquely identifies a resource
ValidityPeriodControl
object
The ValidityPeriod control provides the ability to limit authorization activity to a defined time period
4 properties
3 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
Controls
array
In Control Card Controls
UserDetail
object
4 properties
4 required
Card
object
2 properties
2 required
ErrorWrapper
object
1 property
1 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
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
VcnUserDetail
object
3 properties
3 required
UpdateVCN
object
2 properties
TokenUpdate
object
1 property
TimeOfDayControl
object
The TimeOfDayControl provides the ability to limit authorization activity to defined time periods for each day
3 properties
3 required
Errors
object
1 property
1 required
Control
object
In Control Rule
12 properties
2 required
GeographyControl
object
The GeographicControl provides the ability to control where a card is physically used
2 properties
2 required
ErrorList
array
TimeOfDay
object
3 properties
3 required
VerifiedUser
object
1 property
EnrolledUser
object
4 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
UserUpdate
object
42 properties
2 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
ErrorItem
object
Error Details
5 properties
UserVerificationDetails
object
2 properties
VerificationDetails
object
3 properties
UserAddress
object
This object will define the users default shipping/mailing address.
8 properties
VerifyUser
object
1 property
1 required
Errors_2
object
1 property
1 required
UserDetails
object
33 properties
UserEnroll
object
27 properties
4 required
ErrorsWrapper
object
1 property
1 required
Error_2
object
Error object which contains details about a single error.
5 properties
4 required
UserConsent_2
object
The user consent resource
3 properties
3 required
Errors_2_2
object
Error object which contains a list of error objects.
1 property
1 required
UserReference
object
Successful user enrollment response
3 properties
3 required
SubmitClaimUserData
object
11 properties
1 required
UserName
object
2 properties
2 required
ErrorItem_2
object
5 properties
ErrorResponse_2
object
1 property
1 required
CardExpiry
object
2 properties
Errors_3
array
SubmitClaimUserToken
object
1 property
Address_2
object
9 properties
2 required
CurrencyCode
string
Currency code as per ISO 4217
UserID
string
Unique identifier for a user enrolled in the Carbon Calculator Experience platform.
CardNumber
string
Original payment card number in full.
UpdateUserProfile
object
The request object for updating a enrolled user onto Carbon Calculator Experience platform.
3 properties
2 required
ErrorItems
object
1 property
1 required
Lang
string
Language for the issuer.
AggregateCarbonScore
object
2 properties
2 required
ErrorWrapper_2
object
The error response object gets returned in case of error.
1 property
1 required
UserProfile_2
object
The request object for enrolling a new user to Carbon Calculator Experience API.
8 properties
5 required
Email_2
object
2 properties
Dashboard
object
2 properties
2 required
Error_3
object
5 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mastercard 12
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
#User
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.