🤖Public APIs

This section focuses on a API implementation. We would like to allow for all developers to be able to integrate, even beyond the scope of web3.

Links

• sandbox: https://sandboxapi.0xkyc.id/docs

You can use already configured test account.

apiKey: "test1"

apiSecret: "123456789123456789"

• prod: https://api.0xkyc.id/docs

You need to get issued an apiKey from us.

Please send an email to us [e-mail] using the apiKey request form below after changing #{something} to the proper one.

apiKey request form

Email Title

[ApiKey Request] from #{yourName or organizationName}

Email Content

Dear 0xkyc Support Team,
I am writing to request an API key for accessing the services offered by 0xkyc.

Details:
Name/Organization: #{yourName or organizationName}
Purpose of Integration: #{Briefly describe why you want to integrate with 0xkyc, such as "We are developing a financial app that requires KYC checks for our users."}

Contact Information:
Email: #{yourEmail}
(optional)Website: #{yourWebsiteLink}

APIs

Get JWT format accessToken.

API endpoint to get JWT format accessToken. See below for example requests and responses.

post

/auth

Body

apikeystring · default: test1required

apiSecretstring · default: 123456789123456789required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth' \
  --header 'Content-Type: application/json' \
  --data '{
    "apikey": "test1",
    "apiSecret": "123456789123456789"
  }'

200

400

200

{
  "accessToken": "text"
}

Successfully returns JWT format accessToken

Check whether a specified wallet address holds any SBT tokens on a given blockchain chain.

API endpoint to check whether a specified wallet address holds any SBT tokens on a given blockchain chain. The wallet address should be provided in hex code format starts with 0x. The user can specify the chain they're checking against. Returns a boolean indicating presence or absence of SBT tokens, or an error message in case of invalid parameters or unauthorized issue. See below for example requests and responses.

get

/api/v1/hasSoul

Authorizations

Query parameters

walletAddressstringrequired

chainNamestring · enumrequired

Options: ethereum-goerli, ethereum-sepolia, polygon-mumbai, polygon, scroll-alpha

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/hasSoul?walletAddress=text&chainName=ethereum-goerli' \
  --header 'Authorization: Bearer JWT'

200

400

401

200

{
  "result": true
}

Successfully returns true or false as a result

Get UUID on a given wallet address and blockchain chain.

API endpoint to get UUID on a given wallet address and blockchain chain. The wallet address should be provided in hex code format starts with 0x. The user can specify the chain they're checking against. Returns a string format uuid or empty string, or an error message in case of invalid parameters or unauthorized issue. See below for example requests and responses.

get

/api/v1/uuid

Authorizations

Query parameters

walletAddressstringrequired

chainNamestring · enumrequired

Options: ethereum-goerli, ethereum-sepolia, polygon-mumbai, polygon, scroll-alpha

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/uuid?walletAddress=text&chainName=ethereum-goerli' \
  --header 'Authorization: Bearer JWT'

200

400

401

200

{
  "result": "text"
}

Successfully returns uuid or empty string

Get address, chainId, chainName pairs which has the same UUID.

API endpoint to get address, chainId, chainName pairs which has the same UUID. The uuid should be provided in uuid format. Returns an array of {address, chainId, chainName}, or an error message in case of invalid parameters or unauthorized issue. See below for example requests and responses.

get

/api/v1/pairs

Authorizations

Query parameters

uuidanyrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/pairs?uuid=null' \
  --header 'Authorization: Bearer JWT'

200

400

401

200

[
  {
    "address": "text",
    "chainId": 1,
    "chainName": "text"
  }
]

Successfully returns an array of {address, chainId, chainName} or an empty array