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
user_xid*	String	External identifier, unique under the partner.
user_name	String	Nickname of user account, this is a human-friendly non-unique name for a user account
email*	String	Email address of cardholder
individual*	Object	Individual card holder identity information.
individual.first_name*	String	First name of cardholder
individual.last_name*	String	Last name / Surname of cardholder
individual.date_of_birth*	String	Date of birth (YYYY-MM-DD)
individual.occupation	String	Occupation of card holder.
individual.annual_income	String	Annual income of card holder in card currency
document*	Object	Government Issued Identification Document Information
document.type*	String	1 or 2, enums in Document Type
document.number*	String	Identification document number.
document.country*	String	Issuing country of identification document in ISO3166-1 alpha-2 format
document.expiry_date*	String	Expiry date of identification document (YYYY-MM-DD)
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.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.face	String	The selfie photo file encoded in data URI base64 encoded format. The following mime types are accepted for ID documents: image/jpeg, image/png.
address	Object	Delivery address
address.country	String	Delivery country of identification document in ISO3166-1 alpha-2 format
address.city	String	Delivery city
address.post_code	String	Delivery post code
address.details	String	Detail delivery address

200: OK Success

{
"data":
   { 
    "user_xid":"aabcdfsf",  //user external id       
    "user_id":"8000123",    //user id
    "kyc_status":"0"
   },
"code":"200",
"message":"Success"
}

Code example

// 
curl --location --request POST 'https://api.musepay.io/v1/carduser/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "user_xid": "XUID9982674851738108",
      "user_name": "jasonwood", 
    * "email": "[e-mail]",     
    * "individual" : {
    *     "first_name": "Jack",
    *     "last_name": "Weather",
    *     "date_of_birth": "1988-02-02",
          "occupation": "01",
          "annual_income":"100000"
      },
      "document": {
    *     "type": "passport",
    *     "number": "G012345678",
    *     "country": "China",
    *     "expiry_date": "2030-10-10",
    *     "front": "afjkfjkasfjajsdfkasfjadsf",
    *     "back": "afjkfjkasfjajsdfkasfjasdafasf"
      },
      "address": {
          "country": "BR",
          "city": "RILA",
          "post_code": "GA1234",
          "details": "No.43 Rd Sky",

      }
}'

Create User with KYC link

Create a cardholder with KYC link

POST https://api.musepay.io/v1/carduser/create-with-kyc-link

Request Body

Name	Type	Description
email*	String	Email address of cardholder
user_xid*	String	External identifier, unique under the partner.
user_name	String	Nickname of user account, this is a human-friendly non-unique name for a user account

200: OK Success

{
"data":
   { 
    "user_xid":"aabcdfsf",  //user external id       
    "user_id":"8000123",    //user id
    "kyc_status":"0",
    "link": "https://aaaa.com/kyc-page"
   },
"code":"200",
"message":"Success"
}

Get User KYC link

Get a KYC link for user

POST https://api.musepay.io/v1/carduser/kyc-link

Request Body

Name	Type	Description
user_xid*	String	External identifier, unique under the partner.
level_name	String	LEVEL-1 or LEVEL-2. Default value is LEVEL-1.

200: OK Success

{
"data":
   { 
    "user_xid":"aabcdfsf",  //user external id       
    "link": "https://aaaa.com/kyc-page"
   },
"code":"200",
"message":"Success"
}

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
email	String
user_xid*	String

200: OK Success

{
"data":
   { 
    "user_xid":"aabcdfsf",  //user external id       
    "user_id":"8000123",    //user id
    "kyc_status":"0",
    "email": "[e-mail]",
    "phone_number": "2323",
    "last_name": "abc",
    "first_name": "abc",
    "document_type": "abc",
    "document_number": "aac234"
   },
"code":"200",
"message":"Success"
}

Upload User KYC

Upload User KYC information

POST https://api.musepay.io/v1/carduser/upload-kyc

Request Body

Name	Type	Description
user_xid*	String	External identifier, unique under the partner.
individual*	Object	Individual card holder identity information.
individual.first_name*	String	First name of cardholder
individual.last_name*	String	Last name / Surname of cardholder
individual.date_of_birth*	String	Date of birth (YYYY-MM-DD)
individual.occupation	String	Occupation of card holder.
individual.annual_income	String	Annual income of card holder in card currency
document*	Object	Government Issued Identification Document Information
document.type*	String	1 or 2, enums in Document Type
document.number*	String	Identification document number.
document.country*	String	Issuing country of identification document in ISO3166-1 alpha-2 format
document.expiry_date*	String	Expiry date of identification document (YYYY-MM-DD)
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.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
address	Object	Delivery address
address.country	String	Delivery country of identification document in ISO3166-1 alpha-2 format
address.city	String	Delivery city
address.post_code	String	Delivery post code
address.details	String	Detail delivery address

200: OK Success

{
"data":
   { 
    "user_xid":"aabcdfsf",  //user external id       
    "user_id":"8000123",    //user id
    "kyc_status":"0"
   },
"code":"200",
"message":"Success"
}

Change user email

POST https://api.musepay.io/v1/carduser/change-email

When updating a user’s email, if the user has a card, the associated email on the card will be updated accordingly.

Request Body

Name	Type	Description
user_id	String	User unique ID
email	String	New email address of cardholder

Response

200

{
  "success": true
}