GET
/
v2.01
/
{ClientId}
/
responses
/
{IdempotencyKey}
<?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 = 'your-temporary-folder-path';

    try {
        $idempotencyKey = "fk7urhkW45kpTHf445608d";

        $response = $api->Responses->Get($idempotencyKey);
    
        print_r($response);

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

{
    "StatusCode": "200",
    "ContentLength": "591",
    "ContentType": "application/json; charset=utf-8",
    "Date": "Tue, 19 Jul 2022 08:47:59 GMT",
    "RequestURL": "https://api.mangopay.com/V2.01/clientId/users/natural",
    "Resource": {
        "Address": {
            "AddressLine1": "Rue des plantes",
            "AddressLine2": "The Oasis",
            "City": "Paris",
            "Region": "Ile de France",
            "PostalCode": "75001",
            "Country": "FR"
        },
        "FirstName": "Jane",
        "LastName": "Doe",
        "Birthday": null,
        "Nationality": null,
        "CountryOfResidence": null,
        "Occupation": null,
        "IncomeRange": null,
        "ProofOfIdentity": null,
        "ProofOfAddress": null,
        "Capacity": "NORMAL",
        "Id": "146476890",
        "Tag": "test doc july 2022",
        "CreationDate": 1658220479,
        "PersonType": "NATURAL",
        "Email": "jdoe@mail.com",
        "KYCLevel": "LIGHT",
        "TermsAndConditionsAccepted": true,
        "TermsAndConditionsAcceptedDate": 1658220479,
        "UserCategory": "PAYER"
    }
}

This call returns an API response based on the corresponding idempotency key, within 24 hours of the initial call.

​
Path parameters

​
IdempotencyKey
string
required

Min. length: 16 characters; max. length: 36 characters; only alphanumeric and dashes

A unique string generated by the platform.

​
Responses

{
    "StatusCode": "200",
    "ContentLength": "591",
    "ContentType": "application/json; charset=utf-8",
    "Date": "Tue, 19 Jul 2022 08:47:59 GMT",
    "RequestURL": "https://api.mangopay.com/V2.01/clientId/users/natural",
    "Resource": {
        "Address": {
            "AddressLine1": "Rue des plantes",
            "AddressLine2": "The Oasis",
            "City": "Paris",
            "Region": "Ile de France",
            "PostalCode": "75001",
            "Country": "FR"
        },
        "FirstName": "Jane",
        "LastName": "Doe",
        "Birthday": null,
        "Nationality": null,
        "CountryOfResidence": null,
        "Occupation": null,
        "IncomeRange": null,
        "ProofOfIdentity": null,
        "ProofOfAddress": null,
        "Capacity": "NORMAL",
        "Id": "146476890",
        "Tag": "test doc july 2022",
        "CreationDate": 1658220479,
        "PersonType": "NATURAL",
        "Email": "jdoe@mail.com",
        "KYCLevel": "LIGHT",
        "TermsAndConditionsAccepted": true,
        "TermsAndConditionsAcceptedDate": 1658220479,
        "UserCategory": "PAYER"
    }
}  

<?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 = 'your-temporary-folder-path';

    try {
        $idempotencyKey = "fk7urhkW45kpTHf445608d";

        $response = $api->Responses->Get($idempotencyKey);
    
        print_r($response);

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

Was this page helpful?

The API Response objectThe Country Authorizations object