Show user

To get information about user and as well status for KYC use following endpoint that provides following user information:

GET /api/v1/partners/users/{user_id}

The following parameters are required:

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.kriptomat.io/api/v1/partners/users/1',
    [
        'headers' => [
            'X-Requested-With' => 'XMLHttpRequest',
            'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImZjMzcwNGUxYzJhZGJmNGZkMmQyMWNhZDJjNzcwMjk5NzFmODFkNzc2OTczMTRlOTVhOTllNTYwMjAwMjIwMmYxZmIwZDczODRkYTU4YTkzIn0.eyJhdWQiOiI1IiwianRpIjoiZmMzNzA0ZTFjMmFkYmY0ZmQyZDIxY2FkMmM3NzAyOTk3MWY4MWQ3NzY5NzMxNGU5NWE5OWU1NjAyMDAyMjAyZjFmYjBkNzM4NGRhNThhOTMiLCJpYXQiOjE1NDU3MzQyMTIsIm5iZiI6MTU0NTczNDIxMiwiZXhwIjoxNTQ1NzM3ODEyLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.oD29UustUU7zwBcyp2M45pkAK2c71i6JjQsQTLNfgKQgq9j7lRNy34YbD28MisBpIOrSn7tBRfX2N-CiwxDaeFlNndYGV_8p2zWkzt_S3-Anpg0a1tyImwRp1WgORnD30-kpmwKVsbDJ1C3Mk-TiRgdXBKDGbs43UQ7uG27UoyEeqcyHMDpz0FOa0-ITcwZh2n4lp1gcHpQnon0L-_suTTUvLvPK-yy-nqcHURa5Fmk8dWKechrcZaFwd62T7f2ZuybuM9DjPd87rXHxOYged63Om9OnVOEcWkGSyAeiGwgV4lCFRMQNKUQnp1W_M0gIarwesgJHq4XKBn69SuMJDfUo3oGM3LoxBm_9OfF276SZ3Ta8_njENLX2Dzg-b4FV-GitUeQmJBAji0mwGqp-nhPFCyCUZ91qvNx6tNLAdHR0R3jrJAdBKbw44AfqgABFdzfh1iuahSU1JQ7hu3OIhnvEyWf9XECPdJLywgXNP6Cr2fZpUUxu7EedqJDklPBBZQ-cChvfj8hR4mpdT61DX_1BgwEofOsqRHvvbxaYUVL320MgYKMiS2USXe5d0oznOzJfq7NJ3hIyzCqgITt7w1iChyiNpaTtyp2CysAVSWHOjpFxp00756533ck3CJN8EpccjHiq5sWSaed1iFUKRjicd_4GPNKTmJMPCfg97WI',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

This will return

{
    "status": true,
    "data": {
        "email": "[email protected]",
        "name": "John",
        "surname": "Doe",
        "phone": "+381631283023",
        "date_of_birth": "1963-09-23",
        "address": "Some street 123",
        "building_number": "123",
        "city": "Frankfurt",
        "postal_code": "60306",
        "country": "DEU",
        "status": "active",
        "kyc_status": "passed",
        "edd_status": ""
    }
}

kyc_status will be one of the following:

  • not_started

  • pending

  • failed

  • declined

  • passed

Values and explanation for param edd_status:

  • not_required - EDD check is not required

  • required - EDD check required

  • confirmed - EDD check confirmed

  • failed - EDD check failed

If β€˜passed’, you can carry on with the user flow.

If β€˜pending’, you will need to inform the user of the pending KYC application and await completion.

If β€˜failed’ or β€˜declined’ you will not be able to serve that user.

If β€˜not_started’ the user has not undergone KYC and you can start that process by using a 3rd Party Service

Import User KYC Verification

We support SumSub KYC Applicant Sharing, meaning you can use their service to provide KYC processing of a user and then share their data with Kriptomat. Allowing the user to be KYC approved on Kriptomat.

To do this you will need a SumSub account and our sumsub client_id Use their API to provide the KYC process for your user Generate a share token on SumSub API /resources/accessTokens/-/shareToken?applicantId={applicantId}&forClientId={clientId}

{
  "token": "_act-460a698b-d2bc-4cbc-9456-5f36fee38083",
  "forClientId": "CoolCoinLtd"
}

Pass the token to us - importing their KYC data into Kriptomat

POST v1/users/{user_id}/kyc-import

The following parameters are required:

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://api.kriptomat.io/v1/users/1/kyc-import',
    [
        'headers' => [
            'X-Requested-With' => 'XMLHttpRequest',
            'Authorization' => 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImZjMzcwNGUxYzJhZGJmNGZkMmQyMWNhZDJjNzcwMjk5NzFmODFkNzc2OTczMTRlOTVhOTllNTYwMjAwMjIwMmYxZmIwZDczODRkYTU4YTkzIn0.eyJhdWQiOiI1IiwianRpIjoiZmMzNzA0ZTFjMmFkYmY0ZmQyZDIxY2FkMmM3NzAyOTk3MWY4MWQ3NzY5NzMxNGU5NWE5OWU1NjAyMDAyMjAyZjFmYjBkNzM4NGRhNThhOTMiLCJpYXQiOjE1NDU3MzQyMTIsIm5iZiI6MTU0NTczNDIxMiwiZXhwIjoxNTQ1NzM3ODEyLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.oD29UustUU7zwBcyp2M45pkAK2c71i6JjQsQTLNfgKQgq9j7lRNy34YbD28MisBpIOrSn7tBRfX2N-CiwxDaeFlNndYGV_8p2zWkzt_S3-Anpg0a1tyImwRp1WgORnD30-kpmwKVsbDJ1C3Mk-TiRgdXBKDGbs43UQ7uG27UoyEeqcyHMDpz0FOa0-ITcwZh2n4lp1gcHpQnon0L-_suTTUvLvPK-yy-nqcHURa5Fmk8dWKechrcZaFwd62T7f2ZuybuM9DjPd87rXHxOYged63Om9OnVOEcWkGSyAeiGwgV4lCFRMQNKUQnp1W_M0gIarwesgJHq4XKBn69SuMJDfUo3oGM3LoxBm_9OfF276SZ3Ta8_njENLX2Dzg-b4FV-GitUeQmJBAji0mwGqp-nhPFCyCUZ91qvNx6tNLAdHR0R3jrJAdBKbw44AfqgABFdzfh1iuahSU1JQ7hu3OIhnvEyWf9XECPdJLywgXNP6Cr2fZpUUxu7EedqJDklPBBZQ-cChvfj8hR4mpdT61DX_1BgwEofOsqRHvvbxaYUVL320MgYKMiS2USXe5d0oznOzJfq7NJ3hIyzCqgITt7w1iChyiNpaTtyp2CysAVSWHOjpFxp00756533ck3CJN8EpccjHiq5sWSaed1iFUKRjicd_4GPNKTmJMPCfg97WI',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'token' => 'vYbFMO08Pjt3GSXDy6opuhE8Q50gw3Uf3QBroAC7ns',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

This will return

{
    "status": true
}

Check users kyc-status before continuing.

Last updated

Was this helpful?