Onboarding

To begin using the Yativo APIs you must’ve completed the the onboarding process which includes providing your business details and UBO (Ultimate Beneficial Owner) Verification.

all of which can be done via the dashboard at https://app.yativo.com but if you prefer to submit docs or find any difficulty with this process please reach out to support

Authentication

After successful sign up, you can Login to your dashboard via magic signin at https://app.yativo.com for production or https://test.yativo.com for sandbox, an OTP will be sent to your verified email address and you can set up 2FA (recommended)

API Keys

All API request require authentication by bearer token, to generate a token send a POST request with your Account ID and App Secret which can be found under “Developer” in your Yativo Dashboard.

Content-Type: application/json

POST {{baseUrl}}/auth/login

{
  "account_id": "account_id",
  "app_secret": "app_secret"
}

Example Response

Upon successful authentication, the response will include the access_token, token_type, and expires_in fields.

{
    "status": "success",
    "status_code": 200,
    "message": "Request successful",
    "data": {
        "access_token": "eyJ0e........................",
        "token_type": "bearer",
        "expires_in": 600 //time in seconds 600 seconds = 10 mins
    }
}

Using the Bearer Token

Once you have the access_token, include it in the Authorization header for all subsequent API requests to protected endpoints.

Example Header:

Authorization: Bearer eyJ0edsfdfdf........................ef

By following these steps, you can authenticate with the Yativo API and securely access its protected resources using the provided bearer token.

Idempotency