KriptoRamp / KriptoAPI
Search…
Getting started
Introduction
Use cases 📖
Kripto Ramp Widget and Kripto White Label get started 🏁
Get API keys 🔑
Widget (Fiat Onramp)
Initialise Widget
Load Widget
Widget Configuration
Webhooks
Whitelabel API (Fiat Onramp / Offramp via Bank Wire)
API Reference
Authentication
Endpoints
Users
Create User
Show user
Update User
User Balance
Master Balance
Compliance
Payments & bank wire
Crypto Exchange & Wallet
Webhooks & Websockets
Supported cryptocurrencies 🌍
Links
Kriptomat.io
Powered By GitBook
Show user
To get information about user and as well status for KYC use following endpoint that provides following user information:

GET v1/users/{user_id}

The following parameters are required:
PHP
Javascript
Bash
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.kriptomat.io/v1/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));
const url = new URL(
"https://api.kriptomat.io/v1/users/1"
);
​
let 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",
"Accept": "application/json",
"Content-Type": "application/json",
};
​
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
​
curl -X GET \
-G "https://api.kriptomat.io/v1/users/1" \
-H "X-Requested-With: XMLHttpRequest" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImZjMzcwNGUxYzJhZGJmNGZkMmQyMWNhZDJjNzcwMjk5NzFmODFkNzc2OTczMTRlOTVhOTllNTYwMjAwMjIwMmYxZmIwZDczODRkYTU4YTkzIn0.eyJhdWQiOiI1IiwianRpIjoiZmMzNzA0ZTFjMmFkYmY0ZmQyZDIxY2FkMmM3NzAyOTk3MWY4MWQ3NzY5NzMxNGU5NWE5OWU1NjAyMDAyMjAyZjFmYjBkNzM4NGRhNThhOTMiLCJpYXQiOjE1NDU3MzQyMTIsIm5iZiI6MTU0NTczNDIxMiwiZXhwIjoxNTQ1NzM3ODEyLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.oD29UustUU7zwBcyp2M45pkAK2c71i6JjQsQTLNfgKQgq9j7lRNy34YbD28MisBpIOrSn7tBRfX2N-CiwxDaeFlNndYGV_8p2zWkzt_S3-Anpg0a1tyImwRp1WgORnD30-kpmwKVsbDJ1C3Mk-TiRgdXBKDGbs43UQ7uG27UoyEeqcyHMDpz0FOa0-ITcwZh2n4lp1gcHpQnon0L-_suTTUvLvPK-yy-nqcHURa5Fmk8dWKechrcZaFwd62T7f2ZuybuM9DjPd87rXHxOYged63Om9OnVOEcWkGSyAeiGwgV4lCFRMQNKUQnp1W_M0gIarwesgJHq4XKBn69SuMJDfUo3oGM3LoxBm_9OfF276SZ3Ta8_njENLX2Dzg-b4FV-GitUeQmJBAji0mwGqp-nhPFCyCUZ91qvNx6tNLAdHR0R3jrJAdBKbw44AfqgABFdzfh1iuahSU1JQ7hu3OIhnvEyWf9XECPdJLywgXNP6Cr2fZpUUxu7EedqJDklPBBZQ-cChvfj8hR4mpdT61DX_1BgwEofOsqRHvvbxaYUVL320MgYKMiS2USXe5d0oznOzJfq7NJ3hIyzCqgITt7w1iChyiNpaTtyp2CysAVSWHOjpFxp00756533ck3CJN8EpccjHiq5sWSaed1iFUKRjicd_4GPNKTmJMPCfg97WI"
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:
PHP
Javascript
Bash
$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));
const url = new URL(
"https://api.kriptomat.io/v1/users/1/kyc-import"
);
​
let 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",
"Accept": "application/json",
};
​
let body = {
"token": "vYbFMO08Pjt3GSXDy6opuhE8Q50gw3Uf3QBroAC7ns"
}
​
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
curl -X POST \
"https://api.kriptomat.io/v1/users/1/kyc-import" \
-H "X-Requested-With: XMLHttpRequest" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImZjMzcwNGUxYzJhZGJmNGZkMmQyMWNhZDJjNzcwMjk5NzFmODFkNzc2OTczMTRlOTVhOTllNTYwMjAwMjIwMmYxZmIwZDczODRkYTU4YTkzIn0.eyJhdWQiOiI1IiwianRpIjoiZmMzNzA0ZTFjMmFkYmY0ZmQyZDIxY2FkMmM3NzAyOTk3MWY4MWQ3NzY5NzMxNGU5NWE5OWU1NjAyMDAyMjAyZjFmYjBkNzM4NGRhNThhOTMiLCJpYXQiOjE1NDU3MzQyMTIsIm5iZiI6MTU0NTczNDIxMiwiZXhwIjoxNTQ1NzM3ODEyLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.oD29UustUU7zwBcyp2M45pkAK2c71i6JjQsQTLNfgKQgq9j7lRNy34YbD28MisBpIOrSn7tBRfX2N-CiwxDaeFlNndYGV_8p2zWkzt_S3-Anpg0a1tyImwRp1WgORnD30-kpmwKVsbDJ1C3Mk-TiRgdXBKDGbs43UQ7uG27UoyEeqcyHMDpz0FOa0-ITcwZh2n4lp1gcHpQnon0L-_suTTUvLvPK-yy-nqcHURa5Fmk8dWKechrcZaFwd62T7f2ZuybuM9DjPd87rXHxOYged63Om9OnVOEcWkGSyAeiGwgV4lCFRMQNKUQnp1W_M0gIarwesgJHq4XKBn69SuMJDfUo3oGM3LoxBm_9OfF276SZ3Ta8_njENLX2Dzg-b4FV-GitUeQmJBAji0mwGqp-nhPFCyCUZ91qvNx6tNLAdHR0R3jrJAdBKbw44AfqgABFdzfh1iuahSU1JQ7hu3OIhnvEyWf9XECPdJLywgXNP6Cr2fZpUUxu7EedqJDklPBBZQ-cChvfj8hR4mpdT61DX_1BgwEofOsqRHvvbxaYUVL320MgYKMiS2USXe5d0oznOzJfq7NJ3hIyzCqgITt7w1iChyiNpaTtyp2CysAVSWHOjpFxp00756533ck3CJN8EpccjHiq5sWSaed1iFUKRjicd_4GPNKTmJMPCfg97WI" \
-H "Content-Type: application/json" \
-d '{"token":"vYbFMO08Pjt3GSXDy6opuhE8Q50gw3Uf3QBroAC7ns"}'
This will return
{
"status": true
}
Check users kyc-status before continuing.
Previous
Create User
Next
Update User
Last modified 2mo ago
Copy link
Outline
GET v1/users/{user_id}
Import User KYC Verification
POST v1/users/{user_id}/kyc-import