Creditinfo

Credit reports

Show old credit queries

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

govidstringRequired

Social security number OR Business id

querier_ssnstringRequired

Querier sosial security number. This value can be empty in some cases.

Responses

200

successful operation

application/json

CreditInfoReport

idintegerOptionalExample: 123

namestringOptionalExample: 123

govidstringOptionalExample: 1234567-8

querytypestringOptionalExample: creditplus

querynamestringOptionalExample: Luottotiedot + Yritysyhteydet

datetimestringOptionalExample: 2017-02-09T13:07:00+02:00

whodidstringOptionalExample: John Smith

400

Bad Request

application/json

404

Not found

application/json

get/creditinfo/search/{govid}/{querier_ssn}

HTTPcURLJavaScriptPython

GET /rest/creditinfo/search/{govid}/{querier_ssn} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123",
    "name": "123",
    "govid": "1234567-8",
    "querytype": "creditplus",
    "queryname": "Luottotiedot + Yritysyhteydet",
    "datetime": "2017-02-09T13:07:00+02:00",
    "whodid": "John Smith"
  }
]

Get full report in PDF-format

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportidintegerRequired

Id of report

Responses

200

Report PDF encoded in base64

application/json

CreditInfoPdfDataResponse

datastring · byteOptionalExample: base64encodeddata

400

Bad request

application/json

404

Not Found

application/json

get/creditinfopdf/{reportid}

HTTPcURLJavaScriptPython

GET /rest/creditinfopdf/{reportid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "base64encodeddata"
}

Get rating and riskclass from rating-report

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportidintegerRequired

Id of report

Responses

200

Rating and riskclass from report

application/json

CreditInfoRatingResponse

ratingstringOptionalExample: B

riskclassintegerOptionalExample: 11

400

Bad request

application/json

404

Not found

application/json

get/creditinforating/{reportid}

HTTPcURLJavaScriptPython

GET /rest/creditinforating/{reportid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "rating": "B",
  "riskclass": "11"
}

Get credit rating from credit-report

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

reportidintegerRequired

Id of report

Responses

200

Credit rating from report

application/json

CreditInfoCreditRatingResponse

creditratingstringOptionalExample: 0

400

Bad request

application/json

404

Not found

application/json

get/creditinfopersoncreditrating/{reportid}

HTTPcURLJavaScriptPython

GET /rest/creditinfopersoncreditrating/{reportid} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "creditrating": "0"
}

Make new credit query

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CreditInfoRequest

govidstringRequired

Business Id or Social security number

Example: 2262509-5

creditinfo_reasonstring · enumRequired

Reason for query

Example: 1Possible values:

creditinfo_statusstring · enumRequired

Type of report

Example: krbasicPossible values:

querier_namestringOptional

Querier name

Example: John Doe

querier_ssnstringOptional

Querier sosial security number

Example: 111111-111C

Responses

201

Successful operation

application/json

CreditInfoCreatedResponse

idintegerOptionalExample: 123123

400

Bad request

application/json

post/creditinfo

HTTPcURLJavaScriptPython

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

{
  "govid": "2262509-5",
  "creditinfo_reason": "1",
  "creditinfo_status": "krbasic",
  "querier_name": "John Doe",
  "querier_ssn": "111111-111C"
}

{
  "id": "123123"
}