Skip to main content
POST
/
derogations
/
branches
/
{branchId}
/
check
Check if a derogation is required for a branch/action
curl --request POST \
  --url https://api.example.com/derogations/branches/{branchId}/check \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFieldsToOverride": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "needsDerogation": true
}

Path Parameters

​
branchId
string
required

Id of the branch

Query Parameters

​
action
enum<string>
required

Action for the derogation

Available options:
QUOTE,
CONFIRM,
SIGN

Body

application/json
​
customFieldsToOverride
object[]

Custom fields you want to check derogation requirement with

Response

200 - application/json
​
needsDerogation
boolean
required

Whether a derogation is required for the branch/action