Mastercard · Schema

Profile

Set of Personally Identifiable Information (PII) associated with a given client.

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name	Type	Description
maidenName	string	Maiden name of the client. This field is required if configured as Business Mandatory* .
birthDate	string	Date of birth. Conditional Mandatory* field - Required while creating new client. Date format must be ISO 8601: `YYYY-MM-DD` where: YYYY = four-di
birthCity	string	Birth city of the client. City will be verified against the 'city master setup'. This field is required if configured as Business Mandatory* .
birthCountry	string	Expressed as a 2-letter (Alpha-2) country code as defined in ISO 3166. For example - IN, US, CA, GB This field is required if configured as Business Mandatory*
nationality	string	The status of belonging to a particular nation. Conditional Mandatory* field - Required while creating new client. Expressed as a 2-letter (Alpha-2) country c

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Profile",
  "type": "object",
  "description": "Set of Personally Identifiable Information (PII) associated with a given client.",
  "properties": {
    "maidenName": {
      "type": "string",
      "description": "Maiden name of the client. <br/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>."
    },
    "birthDate": {
      "type": "string",
      "description": "Date of birth. <br/> **Conditional Mandatory**<font color='red'>* </font> field - Required while creating new client. <br/> Date format must be ISO 8601: `YYYY-MM-DD`  <br/> where:  <br/> YYYY = four-digit year  <br/> MM   = two-digit month (01=January, etc.)  <br/> DD = two-digit day of month (01 through 31, as applicable)"
    },
    "birthCity": {
      "type": "string",
      "description": "Birth city of the client. City will be verified against the 'city master setup'. <br/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>."
    },
    "birthCountry": {
      "type": "string",
      "description": "Expressed as a 2-letter (Alpha-2) country code as defined in ISO 3166. <br/> For example - IN, US, CA, GB <br/> This field is required if configured as **Business Mandatory**<font color='red'>* </font>."
    },
    "nationality": {
      "type": "string",
      "description": "The status of belonging to a particular nation. <br/> **Conditional Mandatory**<font color='red'>* </font> field - Required while creating new client. <br/> Expressed as a 2-letter (Alpha-2) country code as defined in ISO 3166. <br/> For example - IN, US, CA, GB"
    }
  }
}