Card User
API endpoints pertaining to the cardholder.
Every request must contain common parameters
Demo code can be found at Github
Create User
Create a cardholder with identity information
POST
https://api.musepay.io/v1/carduser/create
Request Body
Name | Type | Description |
---|---|---|
individual.annual_income | String | Annual income of card holder in card currency |
individual.date_of_birth* | String | Date of birth (YYYY-MM-DD) |
email* | String | Email address of cardholder |
individual.first_name* | String | First name of cardholder |
individual.last_name* | String | Last name / Surname of cardholder |
individual.occupation | String | Occupation of card holder. |
document* | Object | Government Issued Identification Document Information |
user_xid* | String | External identifier, unique under the partner. |
individual* | Object | Individual card holder identity information. |
user_name | String | Nickname of user account, this is a human-friendly non-unique name for a user account |
document.country* | String | Issuing country of identification document in ISO3166-1 alpha-2 format |
document.number* | String | Identification document number. |
document.back | String | The back of a document file encoded in data URI base64 encoded format. The back of a document file encoded in data URI base64 encoded format |
document.front* | String | The front of a document file encoded in data URI base64 encoded format. The following mime types are accepted for ID documents: image/jpeg, image/png. |
document.type* | Integer | 1 or 2, enums in Document Type |
document.expiry_date* | String | Expiry date of identification document (YYYY-MM-DD) |
address | Object | Delivery address |
address.details | String | Detail delivery address |
address.city | String | Delivery city |
address.country | String | Delivery country of identification document in ISO3166-1 alpha-2 format |
address.post_code | String | Delivery post code |
Get User
Get a collection of cardholders based on provided search criteria.
POST
https://api.musepay.io/v1/carduser/query
Request Body
Name | Type | Description |
---|---|---|
user_id | String | |
phone_number | String | |
String | ||
user_xid* | String |
Upload User KYC
Upload User KYC information
POST
https://api.musepay.io/v1/carduser/upload-kyc
Request Body
Name | Type | Description |
---|---|---|
individual.annual_income | String | Annual income of card holder in card currency |
individual.date_of_birth* | String | Date of birth (YYYY-MM-DD) |
individual.first_name* | String | First name of cardholder |
individual.last_name* | String | Last name / Surname of cardholder |
individual.occupation | String | Occupation of card holder. |
document* | Object | Government Issued Identification Document Information |
user_xid* | String | External identifier, unique under the partner. |
individual* | Object | Individual card holder identity information. |
user_id* | String | unique ID in museWallet |
document.country* | String | Issuing country of identification document in ISO3166-1 alpha-2 format |
document.number* | String | Identification document number. |
document.back | String | The back of a document file encoded in data URI base64 encoded format. The back of a document file encoded in data URI base64 encoded format |
document.front* | String | The front of a document file encoded in data URI base64 encoded format. The following mime types are accepted for ID documents: image/jpeg, image/png. |
document.type* | String | passport or national_id |
document.expiry_date* | String | Expiry date of identification document (YYYY-MM-DD) |
address | Object | Delivery address |
address.details | String | Detail delivery address |
address.city | String | Delivery city |
address.country | String | Delivery country of identification document in ISO3166-1 alpha-2 format |
address.post_code | String | Delivery post code |
Last updated