TrustWixDocs
API reference

Manual review

GET
/v1/manual-reviews

Reviews raised on your sessions. Filter with status to see only what is still open. The response carries ids and decisions, never applicant data. Cursor-paginated, newest first. limit accepts 1 to 100 and defaults to 20. To walk further, set starting_after to the id of the last record on the page you just read. has_more tells you another page exists and next_cursor is the value to pass back; on the last page has_more is false and next_cursor is null. An unknown cursor is ignored and you get the first page. Review ids are UUIDs, so starting_after takes a UUID here rather than a prefixed id. Requires the verification:read permission on the calling key.

Authorization

secretKey
AuthorizationBearer <token>

Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).

In: header

Query Parameters

limit?integer

How many records to return. 1 to 100, defaults to 20.

Range1 <= value <= 100
Default20
starting_after?string

A review id; returns the page after it.

Formatuuid
status?string

Where the review sits. queued is waiting to be picked up, in_review is open with a reviewer on it, resolved is closed by an approve or a reject.

Value in

  • "queued"
  • "in_review"
  • "resolved"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/manual-reviews"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "object": "manual_review",      "session_id": "string",      "status": "queued",      "decision": "approve",      "notes": "string",      "reviewed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "has_more": true,  "next_cursor": "string"}
POST
/v1/manual-reviews/{id}/decision

Record where a reviewer landed. approve and reject close the review: status becomes resolved and reviewed_at is stamped. review is not an outcome, it means the reviewer wants another look, so the item stays open at status in_review with reviewed_at still null and keeps appearing in the queue. Submitting a decision again overwrites the previous one, including reopening a resolved review by deciding review on it.

Requires the verification:create permission on the calling key, the same write capability that starts a verification, not verification:read as the listing does.

Authorization

secretKey
AuthorizationBearer <token>

Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).

In: header

Path Parameters

id*string

The review id. Review ids are UUIDs, not prefixed ids.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/manual-reviews/497f6eca-6276-4993-bfeb-53cbbbba6f08/decision" \  -H "Content-Type: application/json" \  -d '{    "decision": "approve"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "manual_review",  "session_id": "string",  "status": "queued",  "decision": "approve",  "notes": "string",  "reviewed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}