List all KYC Documents

GET /v2.01/{ClientId}/kyc/documents

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $response = $api->KycDocuments->GetAll();

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}  

200

[
    {
        "Type": "REGISTRATION_PROOF",
        "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
        "Flags": [],
        "Id": "kyc_01JA5M25P7D6V54J72ENGMPH9Y",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1728913151,
        "ProcessedDate": null,
        "Status": "VALIDATION_ASKED",
        "RefusedReasonType": null,
        "RefusedReasonMessage": null
    },
    {
        "Type": "IDENTITY_PROOF",
        "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
        "Flags": [],
        "Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1728913167,
        "ProcessedDate": 1728913173,
        "Status": "VALIDATED",
        "RefusedReasonType": null,
        "RefusedReasonMessage": null
    }
]

Read more about the KYC Document object →

Query parameters

Status · string

Allowed values: CREATED, VALIDATION_ASKED, VALIDATED, REFUSED, OUT_OF_DATE

The status of the KYC Document. You can filter on multiple values by separating them with a comma.

Type · string

Allowed values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOF

The type of the KYC Document. You can filter on multiple values by separating them with a comma.

BeforeDate · Unix timestamp

The date before which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDate · Unix timestamp

The date after which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Responses

200

Array (KYCDocument) · array

The list of KYC documents created by the platform.

Show properties

Object (KYCDocument) · object

KYC Document created by the platform.

Show properties

Type · string

Returned values: IDENTITY_PROOF, REGISTRATION_PROOF, ARTICLES_OF_ASSOCIATION, SHAREHOLDER_DECLARATION, ADDRESS_PROOF

The type of the document for the user verification.

UserId · string

The unique identifier of the user.

Flags · array

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.

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

Status · string

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 the RefusedReasonType parameter.
• OUT_OF_DATE – The document is downgraded and a new KYC Document object needs to be created to resubmit it.

RefusedReasonType · string

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.

RefusedReasonMessage · string

Max. length: 255 characters

Default value: null

Additional information about why the KYC Document was refused, provided by Mangopay’s team.

200

[
    {
        "Type": "REGISTRATION_PROOF",
        "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
        "Flags": [],
        "Id": "kyc_01JA5M25P7D6V54J72ENGMPH9Y",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1728913151,
        "ProcessedDate": null,
        "Status": "VALIDATION_ASKED",
        "RefusedReasonType": null,
        "RefusedReasonMessage": null
    },
    {
        "Type": "IDENTITY_PROOF",
        "UserId": "user_m_01J8J0Y9DPNYRA9RB532CCND9Q",
        "Flags": [],
        "Id": "kyc_01JA5M2N33ENJHWVPQXVJ6Q51P",
        "Tag": "Created using Mangopay API Postman Collection",
        "CreationDate": 1728913167,
        "ProcessedDate": 1728913173,
        "Status": "VALIDATED",
        "RefusedReasonType": null,
        "RefusedReasonMessage": null
    }
]

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $response = $api->KycDocuments->GetAll();

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}