Your first call will be in sandbox mode. For production calls you'd need to have an existing payment plan setup for your organization. Check out our pricing plans for more information.

Requirements

  • Have an account on Console, which means you have an organization

  • Generated api configurations for the organization hosting your app

  • Added/created an app for use on Console in sandbox mode

If you've the requirements checked then great, let's get started.

Ensure your app is setup properly

Before you make any flow requests ensure you have an application ready to make API requests or call our SDKs by checking this boxes.

  • Have your Client ID available

find-client-id

  • Generate a client secret [circled with blue]

  • If you on a backend technology like node.js, go or other you will need communication keys. So generate them as well. [circled with red]

client-secrets

Choose a client

For your first flow call to pasby, you have two options: utilizing our available SDKs or directly accessing the API endpoints. We strongly recommend leveraging the SDKs whenever possible, unless we haven't yet developed one for your specific technology stack. You are more than welcome at creating SDKs for your technology stack.

A simple authentication request

With the advent of pasby 2.0, we introduced a new paradigm for user authentication through OAuth flows, categorized as hosted authentication. Now, let's guide you through the process of making your first authentication call.

POST
Hosted authentication
cURL "https://oauth.pasby.africa/api/v1/oidc/kipindi" \
-H "x-access-secret: snb_" \
-H "x-api-key: bk-test_" \
-d "{"action": "signup", "claims": ["naming.family","naming.given","contact.email"],
"challenge": "{{pkce-challenge}}", "callback": "https://my.website/auth/callback"
 "payload": "A description of this flow action intent"}"

Was this page helpful?