Creditdecision

Credit Decision

Get exiting decision

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

timestampstringOptional

Decision timestamp found from created decision response data block

Responses

200

Credit decision report

application/json

CreditDecisionReportResponse

created_atstring · dateOptional

Event creation timestamp in ISO8601 format

Example: 2019-08-12T14:36:00+00:00

400

Bad request

application/json

404

Not found

application/json

get

/creditdecision/read

HTTPcURLJavaScriptPython

GET /rest/creditdecision/read HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created_at": "2019-08-12T14:36:00+00:00",
  "data": {
    "timestamp": "2021-03-09T06:09:45.470Z",
    "proposal": {
      "code": "2",
      "text": "Yes",
      "factor": [
        {
          "code": "041",
          "text": "Person has 10 payment defaults, which is 3 pcs."
        }
      ]
    },
    "customer": {
      "name": "Corporation Ltd",
      "businessid": "01234567",
      "ssn": "010203-1234"
    },
    "model": {
      "name": "Yritysmalli (vakio)",
      "code": "YRVAK1"
    }
  }
}

Create new creditdecision

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CreditDecisionReportRequest

idstringRequired

Valid sosial security number or business id

Example: 010203-1234

limitintegerOptional

Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.

Example: 1000

dirstringOptional

Sort direction. Allowed values are 'ASC' or 'DESC'. ASC returns items from oldest to newest (default). DESC returns items from newest to oldest.

Example: DESC

cursorstringOptional

Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.

Example: MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda

Responses

201

Successful operation

application/json

400

Bad request

application/json

post

/creditdecision

HTTPcURLJavaScriptPython

POST /rest/creditdecision HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "id": "010203-1234",
  "limit": "1000",
  "dir": "DESC",
  "cursor": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda"
}

{
  "created_at": "2019-08-12T14:36:00+00:00",
  "data": {
    "timestamp": "2021-03-09T06:09:45.470Z",
    "proposal": {
      "code": "2",
      "text": "Yes",
      "factor": [
        {
          "code": "041",
          "text": "Person has 10 payment defaults, which is 3 pcs."
        }
      ]
    },
    "customer": {
      "name": "Corporation Ltd",
      "businessid": "01234567",
      "ssn": "010203-1234"
    },
    "model": {
      "name": "Yritysmalli (vakio)",
      "code": "YRVAK1"
    }
  }
}

Search from exiting decisions

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CreditDecisionReportRequest

idstringRequired

Valid sosial security number or business id

Example: 010203-1234

limitintegerOptional

Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.

Example: 1000

dirstringOptional

Sort direction. Allowed values are 'ASC' or 'DESC'. ASC returns items from oldest to newest (default). DESC returns items from newest to oldest.

Example: DESC

cursorstringOptional

Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.

Example: MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda

Responses

201

Successful operation

application/json

400

Bad request

application/json

post

/creditdecision/search

HTTPcURLJavaScriptPython

POST /rest/creditdecision/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92

{
  "id": "010203-1234",
  "limit": "1000",
  "dir": "DESC",
  "cursor": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda"
}

{
  "created_at": "2019-08-12T14:36:00+00:00",
  "data": [
    {
      "timestamp": "2021-03-09T06:09:45.470Z",
      "proposal": {
        "code": "2",
        "text": "Yes",
        "factor": [
          {
            "code": "041",
            "text": "Person has 10 payment defaults, which is 3 pcs."
          }
        ]
      },
      "customer": {
        "name": "Corporation Ltd",
        "businessid": "01234567",
        "ssn": "010203-1234"
      },
      "model": {
        "name": "Yritysmalli (vakio)",
        "code": "YRVAK1"
      }
    }
  ],
  "metadata": {
    "next_cursor": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda"
  }
}

Browse exiting decisions

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitintegerOptional

Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.

dirstringOptional

Sort direction. Allowed values are 'ASC' or 'DESC'. ASC returns items from oldest to newest (default). DESC returns items from newest to oldest.

cursorstringOptional

Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.

Responses

201

Successful operation

application/json

400

Bad request

application/json

get

/creditdecision/browse

HTTPcURLJavaScriptPython

GET /rest/creditdecision/browse HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created_at": "2019-08-12T14:36:00+00:00",
  "data": [
    {
      "timestamp": "2021-03-09T06:09:45.470Z",
      "proposal": {
        "code": "2",
        "text": "Yes",
        "factor": [
          {
            "code": "041",
            "text": "Person has 10 payment defaults, which is 3 pcs."
          }
        ]
      },
      "customer": {
        "name": "Corporation Ltd",
        "businessid": "01234567",
        "ssn": "010203-1234"
      },
      "model": {
        "name": "Yritysmalli (vakio)",
        "code": "YRVAK1"
      }
    }
  ],
  "metadata": {
    "next_cursor": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda"
  }
}