Tutorial
Getting started
What Yaqeen does, who uses it, how the first admin account is made, and the order to set things up.
Yaqeen reads your stores, owners and payouts, finds stores that are linked by an exact identifier such as the same bank account, and recommends holds. A hold is a recommendation to keep one payout back. A reviewer decides each one. A merchant can see why and appeal.
Who does what#
| Role | What they do in Yaqeen |
|---|---|
| Reviewer | Reads recommended holds and decides them. Handles appeals. |
| Admin | Sets up the organization, loads data, invites people and manages keys. |
| Engineer | Connects your systems with API keys and webhooks. |
A merchant is a store owner with a limited account. See Roles.
Get the first admin account#
Yaqeen has no sign-up. Your Yaqeen contact creates your organization and its first admin. Send them three values: the organization slug (a short id such as your-org), its name and the first admin's username. They send you a first password by a separate channel. Sign in and change it. See Set up your organization.
Setup order#
- Set up your organization. Follow Set up your organization. It walks through the onboarding checklist: a key, your data, a first hold and a first decision.
- Try the sandbox first if you like. The sandbox is a safe copy with made-up data. The quickstart takes about five minutes.
- Load your data. See Load your data.
- Invite your team. See Invite users and set roles.
- Connect your systems. Use API keys to read and decide, and webhooks to hear about decisions.
- Open the portal to store owners. See Use the merchant portal.
Addresses#
The API lives under /api/v1/. Every response is JSON. Errors have one shape: {"code": "...", "message": "..."}. See Errors.
Next steps#
- Your first hold in the sandbox: see a hold in about five minutes.
- Set up your organization: the order for your real data.
- How holds and appeals work: the idea behind a hold.