{ "opencollection": "1.0.0", "info": { "name": "Mastercard Bill Payment Validator Account Opening Data API", "version": "1.0" }, "items": [ { "info": { "name": "Data", "type": "folder" }, "items": [ { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/user-data-tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Create a user data token for submitting claim." }, { "info": { "name": "Add an Independently Validated Phone Number.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tp-data-shares", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used for a TP to share a User's Identity Attributes. Does not require a minimum authentication standard. \n**This API is optional.**\n" }, { "info": { "name": "Retrieve the details of a document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/document-verifications/document-data-retrievals", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Informs if the document verification is still being processed or is\nprocessed already. If `SUCCESS`, the document data is returned. \n**This API is mandatory.**\n" }, { "info": { "name": "Add and Validate a Document - Retrieve the details of an additional document.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/document-verifications/document-data-retrievals", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Informs if the document verification for the additional document is still being processed (PENDING)\nor is processed already (SUCCESS). If SUCCESS, the document data is\nreturned. \n**This API is mandatory.**\n" }, { "info": { "name": "Add and Validate a Document - Confirm the details of a document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/document-verifications/document-data-confirmations", "headers": [ { "name": "X-User-Identity", "value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "- After the user verifies and checks if the data extracted from the\ndocuments match the current status (for example, Address).\n\n- The user sends data back to MIDS to confirm the details.\n\n- Perform verifications with IVPs and store the data into the PDS. \n**This API is mandatory.**\n" }, { "info": { "name": "Share an Identity with an External RP - Provide the PDS to enable ID for TP to determine if these satisfy an RPs scope request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/claims/user-data-extractions", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the user information from the PDS that is requested by the\nRelying Party based on the ARID. Does not require a minimum authentication standard.\n**This API is mandatory.**\n" }, { "info": { "name": "The provider token is retrieved by country code and SDK version", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/data-extractions/access-tokens", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return a provider token to be passed to the MIDS Liveness SDK module." }, { "info": { "name": "Verifies the details of a selfie with an identity verification provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/data-extractions/facematch", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the Status of the Source Verification that has been processed by a trusted IVP." }, { "info": { "name": "Returns the status of the document verification.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/data-extractions/scans/:scan_id", "headers": [ { "name": "X-Encrypted-Payload", "value": "true" } ], "params": [ { "name": "scan_id", "value": "5226539e-78e7-45ac-a924-072d1301c24c", "type": "path", "description": "UUID returned to the application/webpage on completion of the users interactions with the ID-V SDK." }, { "name": "user_consent", "value": "ACCEPT", "type": "query", "description": "The value which best reflects the input of the User with regard to Consent to use their data (ACCEPT, DECLINE, REVOKE, EXPIRE)." }, { "name": "retrieve_selfie", "value": "true", "type": "query", "description": "Flag indicating if the selfie needs to be retrieved." }, { "name": "retrieve_document_images", "value": "true", "type": "query", "description": "Flag indicating if the document images needs to be retrieved." }, { "name": "retrieve_facemap", "value": "true", "type": "query", "description": "Flag indicating if the facemap needs to be retrieved." }, { "name": "document_type", "value": "DRIVING_LICENSE", "type": "query", "description": "The type of document scanned (DRIVING_LICENSE, PASSPORT, ID_CARD)." }, { "name": "user_selected_country", "value": "USA", "type": "query", "description": "The ISO 3166-1 alpha3 code which corresponds to the country from where the request to ID is originating from." } ] }, "docs": "Returns the status of the document verification as it's being processed by the vendor." } ] } ], "bundled": true }