🤖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

You can use already configured test account.

apiKey: "test1"

apiSecret: "123456789123456789"

You need to get issued an apiKey from us.

Please send an email to us [email protected] 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.

post

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

Body
apikeystringRequiredDefault: test1
apiSecretstringRequiredDefault: 123456789123456789
Responses
200

Successfully returns JWT format accessToken

application/json
post
POST /auth HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "apikey": "test1",
  "apiSecret": "123456789123456789"
}
{
  "accessToken": "text"
}

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

get

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.

Authorizations
Query parameters
walletAddressstringRequired
chainNamestring · enumRequiredPossible values:
Responses
200

Successfully returns true or false as a result

application/json
get
GET /api/v1/hasSoul?walletAddress=text&chainName=ethereum-goerli HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "result": true
}

Get UUID on a given wallet address and blockchain chain.

get

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.

Authorizations
Query parameters
walletAddressstringRequired
chainNamestring · enumRequiredPossible values:
Responses
200

Successfully returns uuid or empty string

application/json
get
GET /api/v1/uuid?walletAddress=text&chainName=ethereum-goerli HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "result": "text"
}

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

get

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.

Authorizations
Query parameters
uuidanyRequired
Responses
200

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

application/json
get
GET /api/v1/pairs?uuid=null HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

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

PreviousNo Code (Etherscan)

Last updated