Overview
User management
- Users
- User regulatory status
- User e-money
User verification
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Create a KYC Document
Create a container for files to be submitted
{
"Tag": "Created using MANGOPAY API Collection Postman",
"Type": "IDENTITY_PROOF"
}
{
"Type": "IDENTITY_PROOF",
"UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
"Flags": [],
"Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1728913167,
"ProcessedDate": null,
"Status": "CREATED",
"RefusedReasonType": null,
"RefusedReasonMessage": null
}
Read more about the KYC Document object →
Path parameters
The unique identifier of the user.
Body parameters
Allowed values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOF
The type of the document for the user verification.
Max. length: 255 characters
Custom data that you can add to this object.
Responses
Returned values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOF
The type of the document for the user verification.
The unique identifier of the user.
Returned values: A code from the Flags list.
The series of codes providing more precision regarding the reason why the identity proof document was refused. You can review the explanations for each code in the Flags list.
The unique identifier of the KYC Document.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
The date and time at which the document was processed by Mangopay’s team.
Returned values: CREATED, VALIDATION_ASKED, VALIDATED, REFUSED, OUT_OF_DATE
The status of the document:
CREATED– The document container is created and files can be uploaded using the POST Create a KYC Document Page endpoint before submission.VALIDATION_ASKED– The document is submitted to Mangopay for validation.VALIDATED– The document is validated by Mangopay’s teams.REFUSED– The document is rejected by Mangopay’s teams and a new KYC Document object needs to be created to resubmit it. You can learn more about the reason why it was refused in theRefusedReasonTypeparameter.OUT_OF_DATE– The document is downgraded and a new KYC Document object needs to be created to resubmit it.
Returned values: DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON
Returned null unless Status is REFUSED.
The reason for the document refusal. See the refused reason types for more information depending on the document type.
Max. length: 255 characters
Default value: null
Additional information about why the KYC Document was refused, provided by Mangopay’s team.
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "da212cf3-7afb-4a49-9c6d-8fa2753f243c#1727446970",
"Date": 1727446971,
"errors": {
"Type": "REGISTRATION_PROOF cannot be submitted for NATURAL_PERSON user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "3824ad65-c0da-4da6-824c-697a58a77b2e#1727446982",
"Date": 1727446983,
"errors": {
"Type": "ARTICLES_OF_ASSOCIATION cannot be submitted for NATURAL_PERSON user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "d91835a1-ce46-4e55-866d-6f1e0de61e75#1727448032",
"Date": 1727448034,
"errors": {
"Type": "SHAREHOLDER_DECLARATION cannot be submitted for NATURAL_PERSON user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "43cddfad-fad7-4ed5-a9c6-bcc4d4b0ef42#1727447421",
"Date": 1727447422,
"errors": {
"Type": "ADDRESS_PROOF cannot be submitted for BUSINESS user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "573e126e-800a-42c4-89cd-b78ff10f0327#1727447489",
"Date": 1727447490,
"errors": {
"Type": "ADDRESS_PROOF cannot be submitted for PARTNERSHIP user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "2fb6cf62-cfb4-4a62-9401-763a53d7f602#1727447342",
"Date": 1727447343,
"errors": {
"Type": "ADDRESS_PROOF cannot be submitted for ORGANIZATION user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "444f5241-5263-4cc0-9ad2-26c871a6cf44#1727447141",
"Date": 1727447142,
"errors": {
"Type": "ADDRESS_PROOF cannot be submitted for SOLETRADER user"
}
}
{
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Id": "fa1adc02-dc72-47be-ab3c-4a0a4ce4ef6b#1727447083",
"Date": 1727447084,
"errors": {
"Type": "ARTICLES_OF_ASSOCIATION cannot be submitted for SOLETRADER user"
}
}
{
"Type": "IDENTITY_PROOF",
"UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
"Flags": [],
"Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1728913167,
"ProcessedDate": null,
"Status": "CREATED",
"RefusedReasonType": null,
"RefusedReasonMessage": null
}
{
"Tag": "Created using MANGOPAY API Collection Postman",
"Type": "IDENTITY_PROOF"
}
Was this page helpful?
{
"Tag": "Created using MANGOPAY API Collection Postman",
"Type": "IDENTITY_PROOF"
}
{
"Type": "IDENTITY_PROOF",
"UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
"Flags": [],
"Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1728913167,
"ProcessedDate": null,
"Status": "CREATED",
"RefusedReasonType": null,
"RefusedReasonMessage": null
}