v2

latestSwagger 2.02026-08-0610101.9 MB

Decisions

Create decision

Creates a decision against the legal person.

The provided verification must have a verification-status of checks-complete, otherwise a 422 is served.

When a decision is successfully created, the legal person's application-status is updated accordingly.

Multiple decisions may be made against the same legal person.

post/v0/legal-persons/{legal-person-id}/decisions

Path parameters

legal-person-idstring required

Request body

verification-urlstring required

A link to the verification.

decision-outcome'accepted' | 'declined' required

decision-notesstring required

Free-text field to explain the reasons behind the decision.

Example request

{
  "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA"
}

Response

Created

decision-outcome'accepted' | 'declined' required

decision-notesstring required

Free-text field to explain the reasons behind the decision.

verification-urlstring required

A link to the verification.

created-atstring date-time required

ISO 8601 formatted date-time.

decision-maker'system' | 'ops-user' | 'user' required

Indicates if the decision was automated or made by a human.

decision-user-urlstring

Link to the user that made the decision (if applicable).

decision-ops-user'griffin-ops-user'

Indicates that an Ops user has created the decision.

decision-user-usernamestring

Username of the user that made the decision (if applicable).

Example response

{
  "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
  "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "decision-user-username": "user@example.com"
}