Skip to main content

Get Client Account

This endpoint allows a user to create new columns in the kanban board.

Request​

URL​

/credit-decision-status

Method​

POST

Headers​

Content-Type: application/json
Authorization: Bearer eyy...

Body​

A JSON representation of credit decision status fields. See below example.

Request Body: all available fields

This section contains all possible fields. For a minimalist example please see the example at the end of this page. We advise starting with the minimum number of fields, ensuring this passes the backend field validations, before proceeding to add new fields.

{
    "status": {
        "type": "String",
        "description": "The name of the column."
    },
    "description": {
        "type": "String",
        "description": "Description of the column."
    },
    "collapsed": {
        "type": "Boolean",
        "description": "Whether the column is collapsed in the UI."
    },
    "enabled": {
        "type": "Boolean",
        "description": "Whether the column is enabled."
    },
}

Response​

  • Status code 200
  • Body a JSON list of results (paginated) of credit decision status objects
  • Headers pagination headers, including link to next page
Response Body

{
    "id": {
        "type": "String",
        "description": null
    },
    "status": {
        "type": "String",
        "description": "The name of the column."
    },
    "description": {
        "type": "String",
        "description": "Description of the column."
    },
    "index": {
        "type": "Integer",
        "description": "Index decides in what order the columns on the kanban board are displayed."
    },
    "collapsed": {
        "type": "Boolean",
        "description": "Whether the column is collapsed in the UI."
    },
    "enabled": {
        "type": "Boolean",
        "description": "Whether the column is enabled."
    },
}

Example​

Request​

Request Call​

curl -X POST \
  'https://api.{domain}/credit-decision-status' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer eyy...' \
  -d '{"description":"test","enabled":true,"collapsed":true,"status":"TEST"}'
Example Request Body

{
    "description": "Mock description",
    "enabled": true,
    "collapsed": true,
    "status": "MOCK"
}

Example Response Body

{
    "id": "123",
    "description": "Mock description",
    "enabled": true,
    "collapsed": true,
    "status": "MOCK",
    "index": 3
}