Getting Started

Onboarding

To begin using the Yativo APIs you must complete the onboarding process which includes providing your business details and UBO (Ultimate Beneficial Owner) verification. You can complete this via the dashboard at https://app.yativo.com. If you prefer to submit documents or encounter any difficulty with this process, please reach out to support.

Authentication

1

Login (Magic Sign-in)

Log in to your dashboard via magic signin at:

• Production: https://app.yativo.com

• Sandbox: https://test.yativo.com

An OTP will be sent to your verified email address. You can set up 2FA (recommended).

2

Generate API Key (Access Token)

All API requests require authentication by bearer token. To generate a token, send a POST request with your Account ID and App Secret (found under “Developer” in your Yativo Dashboard).

Request

Content-Type: application/json

POST {{baseUrl}}/auth/login

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

3

Example Response

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

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "access_token": "eyJ0e........................",
    "token_type": "bearer",
    "expires_in": 600
  }
}

Use the access_token in the Authorization header for all subsequent protected API requests.

Example header: Authorization: Bearer eyJ0edsfdfdf........................ef

Idempotency

To ensure safe retries and prevent duplicate operations, include an Idempotency-Key header on all POST, PUT, and PATCH requests. This key ensures the same request is not processed multiple times unintentionally due to network issues, client retries, or unexpected failures.

Environments

Production

Base URL: https://api.yativo.com/api/v1

Test / Sandbox