How-to guide
Go live checklist
What to check before you send real payouts to Yaqeen and let reviewers decide on real holds.
This checklist lists what to check before you load real data. An admin does most steps. Do the steps in order. Each one has a check that you can run with the API.
Before you start#
You need an admin account in your organization. Finish the sandbox first, so you have seen one hold from start to end with made-up data.
Checklist#
- Test in the sandbox. Create the sandbox, load the sample data and run scoring with a
yq_test_key. Check that a hold appears and that you can decide it. Nothing in the sandbox reaches your real data. - Have at least two admins. A policy change or an account change waits for a second admin. With one admin, the change runs with no second person. Invite another admin with
POST /api/v1/users/invites/. Check withGET /api/v1/users/?role=admin&is_active=truethat two admins are listed. - Invite your reviewers. Send one invitation for each person, with the role
revieweroradmin. A link works once and ends in 7 days. See Invite users and set roles. If someone loses access, an admin sendsPOST /api/v1/users/{id}/reset-link/. The answer shows a one-time token once. The token works once and ends after 60 minutes, and a new link ends older ones. The person then sends the token and a new password toPOST /api/v1/auth/password/reset/. - Create a live key with the least access it needs. Choose only the scopes the system uses, a short life in days and a rate that fits. If the system has fixed addresses, list them in
allowed_ips. Use one key for each system. The key is shown once. Plan its rotation: a rotated key keeps the old one working for 24 hours. See Authentication. - Check the limits. Read
GET /api/v1/policy/,GET /api/v1/approvals/settings/andGET /api/v1/queue/settings/. Look at the hold days, the appeal window, the amount that needs a second person and the review time. See Settings. - Load your data with a dry run first. Identifiers arrive already hashed. Save a mapping, then send
POST /api/v1/ingest/connect/. The default is a dry run. It reports what would be created and which row would fail. Fix every problem, then send again with"dry_run": false. See Load your data. - Run scoring. Send
POST /api/v1/scoring/runs/. The answer is202with a job. A scheduled task runs the job, so wait for it. PollGET /api/v1/jobs/{id}/until the job finishes. Then listGET /api/v1/holds/?status=recommended. - Decide one hold. A reviewer reads the reasons and approves or rejects with a note. See Review a hold.
- Add a webhook and test it. Add the endpoint, send a
ping, check the signature, and ignore repeated event ids. See Webhooks. - Check the audit chain. Send
GET /api/v1/ops/audit-verify/. The answer must be"intact": true. See Export and verify the audit log. - Check platform health. Send
GET /api/v1/ops/health/. It answersokorattention.attentionmeans a job failed in the last day, a job waited more than 15 minutes, the audit chain does not verify, an open error was recorded in the last day, or a deployment failed. Ask your Yaqeen contact to confirm that the daily checks and an alert channel are set up. - Check appeal files, if merchants will upload. If upload is not switched on, the endpoints answer
503 storage_off. Ask your Yaqeen contact to switch it on.
What you see now#
Send GET /api/v1/onboarding/. It shows four setup steps, key, data, hold and decision, and marks each one as done when the data exists. Reviewers and admins can read it.
{ "steps": [ { "id": "key", "title": "Create an API key", "done": true } ], "done": 1, "total": 4, "next": "data", "complete": false }The example shows one of the four steps. When all four are done, complete is true and next is null. The checklist reads your real data, so it does not store anything itself. A key of any scope counts for key. Any payout counts for data.
If it does not work#
- The dry run reports a row problem: fix that row. The message names the row and the cause. See Handle errors.
- Scoring finishes and no hold appears: with little data, Yaqeen has little to check. Check that your stores, payouts and orders are loaded.
- A step in the checklist stays
false:GET /api/v1/onboarding/counts data in your own organization, not in the sandbox.
Next steps#
- Handle errors: what to do when a call fails.
- Webhooks: events for your own systems.
- Settings: the limits you can change.
- Troubleshooting: fixes for common symptoms.