Update a draft report

Scope: reports:create

Edits a report in DRAFT. Nothing is billed and no check runs until the draft is launched.

Authorization

AuthorizationBearer <token>

Use Authorization: Bearer vrf_live_... or vrf_test_....

In: header

Path Parameters

reportId*string

Report identifier.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subject*

checksRequested*array<>

Check names to run. Every check must accept the subject's subjectType.

Items1 <= items

checkStack?array<>

Optional richer form of checksRequested that carries per-check inputs. When present it must list the same checks.

purpose?string

Why the check is being run. Shown to the subject when consent is hosted, and stored for audit.

consent?

How consent for this report is obtained. With CUSTOMER_ATTESTED, the remaining fields are your record of the consent you collected.

paymentMode?PaymentMode

Who pays for the report.

Mode	Payer
`SELF`	Your workspace.
`CANDIDATE`	The subject, through a payment link.
`THIRD_PARTY`	Someone else you nominate, through a payment link.

Value in

"SELF"
"CANDIDATE"
"THIRD_PARTY"

draft?boolean

Create without launching. The report stays in DRAFT until launched.

Defaultfalse

requireConsent?boolean

Whether the report is gated on consent. Defaults to true.

Defaulttrue

inviteSubject?boolean

Defaultfalse

idempotencyKey?string

Body equivalent of the Idempotency-Key header, for use per report in a bulk request.

checkInputs?

attachments?array<>

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft" \  -H "Content-Type: application/json" \  -d '{    "subject": {      "subjectType": "INDIVIDUAL",      "fullName": "Jane Wanjiku Doe"    },    "checksRequested": [      "IDENTITY"    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "DRAFT",  "subject": {    "subjectType": "INDIVIDUAL",    "fullName": "Jane Wanjiku Doe",    "firstName": "string",    "middleName": "string",    "lastName": "string",    "idNumber": "36901234",    "registrationNumber": "PVT-7XUQ8KL",    "email": "user@example.com",    "phone": "+254712345678",    "dateOfBirth": "2019-08-24",    "country": "KE"  },  "checksRequested": [    "IDENTITY"  ],  "checkResults": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "checkName": "IDENTITY",      "status": "PENDING",      "summary": "string",      "riskLevel": "LOW",      "score": 0,      "evidence": {},      "completedAt": "2019-08-24T14:15:22Z"    }  ],  "riskScore": 0,  "riskLevel": "LOW",  "consentState": {    "status": "NOT_REQUIRED",    "consentUrl": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z"  },  "paymentState": {    "status": "NOT_REQUIRED",    "amount": {      "amount": 0.1,      "currency": "KES"    },    "paidAt": "2019-08-24T14:15:22Z"  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}