Audit

Create a new audit

POST https://api.borlaug.network/a/audits

Headers

Name
Type
Description

Content-Type

string

application/json

BWS-Idempotency-Key

string

Authentication

string

Authentication token

Request Body

Name
Type
Description

auditor

string

Public key of the auditor

audit_type

string

One of GAP, RSPO

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}
{
	"auditor":"5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY",
	"audit_type":"GAP"
}

Auditor accepts or rejects an audit

PATCH https://api.borlaug.network/a/audits/:auditid

An auditor accepts request to perform an audit

Path Parameters

Name
Type
Description

auditid

string

Headers

Name
Type
Description

Content-Type

string

application/json

BWS-Idempotency-Key

string

Authentication

string

Request Body

Name
Type
Description

accept

boolean

accept or reject an audit

{
	"accept":true
}

Retrieve audits

GET https://api.borlaug.network/a/audits

Retrieve all audits for a given creator or auditor.

Query Parameters

Name
Type
Description

per_page

string

For pagination

page

string

For pagination

auditor

string

Public key of auditor

status

string

One of Requested, Accepted, Rejected, InProgress, Completed

creator

string

creator | Public key of creator

Headers

Name
Type
Description

Authentication

string

BWS-Idempotency-Key

string

Delete an audit

DELETE https://api.borlaug.network/a/audits/:auditid

A producer can delete an audit if it's in Requested state.

Path Parameters

Name
Type
Description

auditid

string

Headers

Name
Type
Description

BWS-Idempotency-Key

string

Authentication

string

Last updated

Was this helpful?