Quickstart

This guide will get you all set up and ready to use the pasby API. We'll cover how to get started using one of our API clients and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.

Domains

pasby™ integrations can either be created for production or sandbox use. Each environment has it's consequences.

Production grade apps make calls to --- https://l.pasby.africa

Sandbox apps make calls to --- https://s.pasby.africa

Organisation service file should like this:

{
  type: "consumer",
  clientid: "bcn_",
  apikeys: {
    live: "bk-live_",
    test: "bk-test_",
  }
  ...
}

While app service file should like this:

{
  type: "app",
  appid: "app_",
  consumer: "bcn_",
  ...
}

The files will be provided to you as a zip folder containing *_service.json and your *.pem files. The pem files are very important during for communications between pasby™ and your app. More on that later.

Choose your client

Before making your first API request, you need to pick which API client you will use. In addition to good ol' cURL HTTP requests, pasby™ currently offers clients for JavaScript. In the following example, you can see how to install each client.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After picking your preferred client, you are ready to make your first call to the pasby API. Below, you can see how to send a POST request to the Identifications endpoint to begin a secure authentication flow.

curl --location 'https://s.pasby.africa/api/v2/identification/wildcard' \
--header 'x-access-secret: snb_' \
--header 'x-api-key: bk-test_' \
--data '{
    "action": "signup",
    "claims": ["naming.family", "naming.given", "contact.email"],
    "seeds": 4,
    "payload": "Use text to explain the intent"
}'

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the pasby™ API integrations:

• Grab your auth credentials from the developer console
• Learn how to integrate pasby through the official sample code
• Check out the Identifications endpoint
• Learn about the different error messages in pasby