# Card User
{% hint style="warning" %}
Every request must contain [common parameters](/reference/api-reference/common-parameters.md)
{% endhint %}
{% hint style="info" %}
Demo code can be found at [Github](/reference/api-reference.md#demo-client)
{% endhint %}
## **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.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.
|
| document.type\* | String | 1 or 2, enums in [Document Type](/enums/document-type.md) |
| 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 |
{% tabs %}
{% tab title="200: OK Success" %}
{
"data":
{
"user_xid":"aabcdfsf", //user external id
"user_id":"8000123", //user id
"kyc_status":"0"
},
"code":"200",
"message":"Success"
}
{% endtab %}
{% endtabs %}
Code example
```java
//
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": "carduser001@musepay.io",
* "individual" : {
* "last_name": "Weather",
* "first_name": "Jack",
* "date_of_birth": "1988-02-02",
"occupation": "01",
"annual_income":"100000"
},
"document": {
* "type": "passport",
* "front": "afjkfjkasfjajsdfkasfjadsf",
* "back": "afjkfjkasfjajsdfkasfjasdafasf",
* "number": "G012345678",
* "country": "China",
* "expiry_date": "2030-10-10"
},
"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 |
{% tabs %}
{% tab title="200: OK Success" %}
```javascript
{
"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"
}
```
{% endtab %}
{% endtabs %}
## **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. |
{% tabs %}
{% tab title="200: OK Success" %}
```javascript
{
"data":
{
"user_xid":"aabcdfsf", //user external id
"link": "https://aaaa.com/kyc-page"
},
"code":"200",
"message":"Success"
}
```
{% endtab %}
{% endtabs %}
## **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 | |
{% tabs %}
{% tab title="200: OK Success" %}
```json
{
"data":
{
"user_xid":"aabcdfsf", //user external id
"user_id":"8000123", //user id
"kyc_status":"0",
"email": "abc@abc.com",
"phone_number": "2323",
"last_name": "abc",
"first_name": "abc",
"document_type": "abc",
"document_number": "aac234"
},
"code":"200",
"message":"Success"
}
```
{% endtab %}
{% endtabs %}
## 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. |
| 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 | 1 or 2, enums in [Document Type](/enums/document-type.md) |
| 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 |
{% tabs %}
{% tab title="200: OK Success" %}
{
"data":
{
"user_xid":"aabcdfsf", //user external id
"user_id":"8000123", //user id
"kyc_status":"0"
},
"code":"200",
"message":"Success"
}
{% endtab %}
{% endtabs %}
## 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**
{% tabs %}
{% tab title="200" %}
```json
{
"success": true
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs-card.musepay.io/reference/api-reference/card-user.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.