Integrate with Jomo in 30 Minutes

Preparation

RESTful integration ready backend
Place to secretly store and use the Jomo provided API key
(Provide to Jomo) A callback API to receive results (payload details below)
(Provide to Jomo) A redirect URL for Jomo to redirect users to after verification
(Provide to Jomo) Your project’s name (to be displayed on the webpage)
(Provide to Jomo) URL to fetch your Logo (square, size > 80*80)
(Get from Jomo) Your Jomo API key to use with Start Query call (more details below)
(Get from Jomo) API key for Jomo to authenticate when calling the callback

3 Steps Integration

Initiate the Query

Make a POST request to Start Query API
Get back the query_id, store the association between query_id and wallet_address

Redirect users to the Jomo hosted verification flow

Design your page as you prefer and lead users into the url returned from the API to complete verification

Wait for results

Results will be sent to Callback API after user completes verification and consents to share their results
Once a query has been shared by the user, calling Start Query API again will also get results returned immediately

API Reference

Callback API

Jomo will send you a callback once user completed verification and shared their result with you. The callback will be sent to the callback API prepared and provided as instructed above.

Request Method: POST
Request Payload:

{
  "api_key": "<your_callback_api_key>",
  "query_id": "<example_query_id>",
  "wallet_address": "<example_wallet_address>",
  "results": {  // Example fields below
    "state": "CA",
    "country": "US",
    "above_21": true
  }
}

Start Query API

You will send Jomo this API call to start a query for a wallet address.

Request Method: POST
URL: https://app.jomo.network/api/start_query
Request Params:

{
  "api_key": "<your_jomo_api_key>",
  "wallet_address": "<wallet_address_to_query>"
}

Response Format (when status is pending or completed):

{
  "query_id": "<example_query_id>",
  "url": "https://app.jomo.network/<example_query_id>",
  "wallet_address": "<example_wallet_address>",
  "status": "<pending|completed>"
}

Response Format (when status is shared):

{
  "query_id": "<example_query_id>",
  "url": "https://app.jomo.network/<example_query_id>",
  "wallet_address": "<example_wallet_address>",
  "status": "shared",
  "results": {  // Example fields below
    "state": "CA",
    "country": "US",
    "above_21": true
  }
}

Status Definition

pending: Waiting for user to complete the required verifications
completed: Verifications are completed and successful, waiting for user to consent and share the results
shared: User has consented and results have been shared

Questions or Want a Demo?

Find us at [email protected]