Consent API

5 operations from the external ASIRI OpenAPI surface.

Public endpoint

GET`/v1/consent`

List consent notices

Requiresconsent:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`status`	query	no	`string`	-
`domain`	query	no	`string`	-
`search`	query	no	`string`	-
`cursor`	query	no	`string`	-
`limit`	query	no	`integer`	-

Request body

No request body.

Responses

GET/v1/consentPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/consent' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "data": [
      {}
    ],
    "page": {
      "cursor": "string",
      "nextCursor": "string",
      "limit": 1,
      "total": 1
    }
  }
}

Public endpoint

GET`/v1/consent/{id}`

Get a consent notice by id

Requiresconsent:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

No request body.

Responses

GET/v1/consent/{id}Public schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/consent/{id}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {}
}

Public endpoint

GET`/v1/consent/{id}/records`

List consent records captured against a notice

Requiresconsent:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-
`cursor`	query	no	`string`	-
`limit`	query	no	`integer`	-

Request body

No request body.

Responses

GET/v1/consent/{id}/recordsPublic schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/consent/{id}/records' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {
    "data": [
      {}
    ],
    "page": {}
  }
}

Public endpoint

POST`/v1/consent/{id}/records`

Capture a new consent record (append-only)

Captures a single consent record against a published notice. The notice MUST be in status='published'; a draft or archived notice returns 409 conflict with `code: "consent_notice_not_published"` and `requiredStatus` / `actualStatus` fields on the error envelope. Publish via POST /v1/consent/{id}/publish before capturing. The records ledger is append-only — withdrawals create a new linked row rather than mutating the original.

Requiresconsent:write

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-

Request body

application/jsonobject

Responses

POST/v1/consent/{id}/recordsPublic schema

curl --request POST \
  --url 'https://api.asiri.ng/v1/consent/{id}/records' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subjectId": "string",
  "purposes": {
    "key": true
  },
  "subjectChannel": "email",
  "ip": "string",
  "ua": "string",
  "method": "banner"
}'

Example response201

application/json

{
  "data": {}
}

Public endpoint

GET`/v1/consent/{id}/records/{recordId}`

Get a single consent record

Requiresconsent:read

Security

bearerAuthorization: Bearer <ASIRI_API_KEY>

Parameters

Name	In	Required	Schema	Description
`id`	path	yes	`string`	-
`recordId`	path	yes	`string`	-

Request body

No request body.

Responses

GET/v1/consent/{id}/records/{recordId}Public schema

curl --request GET \
  --url 'https://api.asiri.ng/v1/consent/{id}/records/{recordId}' \
  --header 'Authorization: Bearer <ASIRI_API_KEY>'

Example response200

application/json

{
  "data": {}
}

Consent API

GET/v1/consent

Security

Parameters

Request body

Responses

GET/v1/consent/{id}

Security

Parameters

Request body

Responses

GET/v1/consent/{id}/records

Security

Parameters

Request body

Responses

POST/v1/consent/{id}/records

Security

Parameters

Request body

Responses

GET/v1/consent/{id}/records/{recordId}

Security

Parameters

Request body

Responses

GET`/v1/consent`

GET`/v1/consent/{id}`

GET`/v1/consent/{id}/records`

POST`/v1/consent/{id}/records`

GET`/v1/consent/{id}/records/{recordId}`