GET
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
kyc
/
documents
<?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 {
    $userId ='146476890';

    $response = $api->KycDocuments->GetAll($userId);

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

[
    {
        "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.

​
Path parameters

​
UserId
string
required

The unique identifier of the user.

​
Responses

[
    {
        "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 

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 {
    $userId ='146476890';

    $response = $api->KycDocuments->GetAll($userId);

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