Description and definition
Versions:
001 document base
002 document’s extensions
error messages
ISIR url
Domiciles ic
003 description for new response from web method.
The client’s debug support
Collections of data domain
Versioning of response
004 Justitia CZ. Fix of reportVersion element.
005 New element added to the Involvement section.
006 Description of the birthDate element in request version 3.
Description
The web service method for subject’s info genaration. This method returned information about credit risk data.
Credit risk data
Output contais data from ISIR and DOMICILES.
The reportVersion = 2 contains other data:
Id card validity. Stolen or lost.
Birth number validity
Data collections
Real estate
Execution registry.
From 2014/03 exists a Justitia data inside version 2.
Web method input parameters:
The web method has the one input parameter only. This parameter is a XML with subject’s data.
name | datatype | mandatory | Notice |
subjectData | XMLDocument | yes |
Web method output data:
The output is XML with any information about risks or about subject’s state. In error case output contains an error information.
datatype | mandatory | Notice |
XMLDocument | yes |
SOAP header:
The web method has the SOAP header.. This header contains login values..
<soap:Header> <CreditCheckHeader xmlns="http://creditcheck.cz/"> <Login>string</Login> <Password>string</Password> </CreditCheckHeader> </soap:Header>
WSDL
WSDL bellow will be available on url http://creditwebservices.creditcheck.cz/CreditCheckAktualizace.asmx?op=GetSubjectBasicReport
SOAP 1.1
POST /CreditCheckWebServices/CreditCheckAktualizace.asmx HTTP/1.1 Host: creditwebservices.creditcheck.cz Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://creditcheck.cz/GetSubjectBasicReport" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <CreditCheckHeader xmlns="http://creditcheck.cz/"> <Login>string</Login> <Password>string</Password> </CreditCheckHeader> </soap:Header> <soap:Body> <GetSubjectBasicReport xmlns="http://creditcheck.cz/"> <subjectData>xml</subjectData> </GetSubjectBasicReport> </soap:Body> </soap:Envelope> HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetSubjectBasicReportResponse xmlns="http://creditcheck.cz/"> <GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult> </GetSubjectBasicReportResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
POST /CreditCheckWebServices/CreditCheckAktualizace.asmx HTTP/1.1 Host: creditwebservices.creditcheck.cz Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Header> <CreditCheckHeader xmlns="http://creditcheck.cz/"> <Login>string</Login> <Password>string</Password> </CreditCheckHeader> </soap12:Header> <soap12:Body> <GetSubjectBasicReport xmlns="http://creditcheck.cz/"> <subjectData>xml</subjectData> </GetSubjectBasicReport> </soap12:Body> </soap12:Envelope> HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetSubjectBasicReportResponse xmlns="http://creditcheck.cz/"> <GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult> </GetSubjectBasicReportResponse> </soap12:Body> </soap12:Envelope>
Requests to webmethod - input parameter description
.
Type 1: request for private person
<requestSubject> <reportVersion>2</reportVersion> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> <idCard>123456KK</idCard> <checkInExecutionRegistry>1</ checkInExecutionRegistry > <checkInRealEstate>1</checkInRealEstate > <checkInJustitiaCz>1</checkInJustitiaCz> reportVersion </requestSubject>
request for private person, version 3
Request with the birthDate element (with a relations) is less accurate as request with the birthNumber element.
<requestSubject> <reportVersion>3</reportVersion> <subjectType>privatePerson</subjectType> <birthDate>10.10.1977</birthDate> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> <idCard>123456KK</idCard> <checkInExecutionRegistry>1</ checkInExecutionRegistry > <checkInRealEstate>1</checkInRealEstate > <checkInJustitiaCz>1</checkInJustitiaCz> reportVersion </requestSubject>
Element name | datatype | mandatory | reportVersion | relation | Notice |
subjectType | string | yes | privatePerson | ||
birthNumber | string | yes | |||
birthDate | string | relation | 3 | Is necessary combine this element with the firstName and the surname elements. | |
firstName | string | yes | |||
surname | string | yes | |||
address | Root element for data of address. | ||||
street | string | yes | |||
number | string | yes | |||
city | string | yes | |||
zip | string | yes | |||
idCard | string | no | 2 | The reportVersion 2 only. | |
reportVersion | string | no | If exist this element and value is 2 then response will contains all relevant data for current data domain. Data will return as collection. Some data domains are unique and collections not exists. Look on current collection. | ||
checkInExecutionRegistry | string | no | 2 | The reportVersion 2 only. When element exists and value is 1 than subject will check in the Execution database. | |
checkInRealEstate | string | no | 2 | The reportVersion 2 only. When element exists and value is 1 than subject will check in the Real estate database. | |
checkInJustitiaCz | string | no | 2 | From 2014/03 and reportVersion 2 only. When element exists and value is 1 than subject wil check in the Justitia CZ registry. |
Response from webmethod - data description
Type 1: response for private person request
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <requestVersion>2</requestVersion> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> <idCard>123456KK</idCard> <checkInExecutionRegistry>1</ checkInExecutionRegistry > </requestSubject> <report> <status>3</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <ic>701689523</ic> <idCard>OK</idCard> <invalidBirthNumber>INVALID</invalidBirthNumber> <isir> <isirRecord> <id>5698</id> <spisZnacka>INS 4/2008</spisZnacka> <cas>2008-01-02 12:49:37.000</cas> <udalost>Sdělení</udalost> <druhStavRizeni>NEVYRIZENA</druhStavRizeni> <isirUrl>https://isir.justice.cz/...</isirUrl> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl> </isirRecord> </isir> <domicileMunicipality > <muniName>Obecní úřad Praha 6</muniName>> <fullAddress>Krátká 8/12, Praha, 30100</fullAddress> </domicileMunicipality> </report> </creditCheck>
Element name | datatype | mandatory | Notice |
webMethod | string | yes | Name of web service method |
time | datetime | yes | Time of data generation on our server |
requestSubject | yes | Root element with input data. | |
subjectType | string | yes | privatePerson |
birthNumber | string | yes | |
firstName | string | yes | |
surname | string | yes | |
address | Root element for data of address. | ||
street | string | yes | |
number | string | yes | |
city | string | yes | |
zip | string | yes | |
report | Root element for data with risk info. | ||
status | int | no | CreditCheck status. This value will display when subject is same as privateBussines subject inside our database. It is same as ic element. |
fullReportUrl | string | yes | Url to CreditCheck FullReport as timelink. |
birthNumber | string | yes | |
firstName | string | yes | Přehlasovaná písmena jako (ö, ü, ä) jsou z pohledu systémů unikátní znaky. Není tedy možné je implicitně nahrazovat jiným znakem jako např. ("OE", "UE", "AE"). Takové jméno osoby by pak nebylo úspěšně dohledáno. |
surname | string | yes | |
address | Root element for data of address. | ||
street | string | yes | |
number | string | yes | |
city | string | yes | |
zip | string | yes | |
ic | string | no | This value will display when subject is same as privateBussines subject inside our database. |
idCard | String | no | When requestVersion is 2 only. This element have got two values. OK = card is OK. INVALID = card was stolen , lost or other problem. |
invalidBirthNumber | String | no | When requestVersion is 2 only. This element will show when our validation of birth number was wrong. Value element inside will INVALID . When birth number is right then element missing. |
isir | no | Root element for the ISIR risk data. When subject has not ISIR risk data then element will not exist. Last record from database only. This data domain is unique and collection not exist. | |
isirRecord | Envelope element for one record. | ||
id | int | yes | Record Id from our database. |
spisZnacka | string | yes | |
cas | datetime | yes | |
udalost | string | yes | |
druhStavRizeni | string | yes | |
isirUrl | string | yes | Link directtly to ISIR page. |
dokumentUrl | string | yes | Link directtly to document’s copy on ISIR pages. |
id | int | yes | Record id from our database. |
privateFullName | string | yes | If the requestVersion element exists and value is 2. |
dluhCelkem | number | yes | Total debt |
evidovanoOd | datetime | yes | Evidence from. (In our database.) |
evidovanoDo | datetime | no | Evidence to. (In our database.) If don’t exists then record is current. |
birthDate | string | no | If the requestVersion element exists and value is 2. |
address | string | No | If the requestVersion element exists and value is 2. |
id | int | yes | Record id from our database. |
privateFullName | string | yes | If the requestVersion element exists and value is 2. |
dluhCelkem | number | yes | Total debt |
evidovanoOd | datetime | yes | Evidence from. (In our database.) |
evidovanoDo | datetime | no | Evidence to. (In our database.) If don’t exists then record is current. |
birthYear | string | no | If the requestVersion element exists and value is 2. |
address | string | No | If the requestVersion element exists and value is 2. |
domicileMunicipality | no | Root element for the Domicile risk. When subject has not Domicile risk data then element will not exist. | |
muniName | string | no | Name of municipality |
fullAddress | string | yes | Full municipality address. |
Example for subject without credit risk data
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </requestSubject> <report> <status>1</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </report> </creditCheck>
Example for ISIR risk subject
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </requestSubject> <report > <status>3</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <ic>701689523</ic> <isir> <isirRecord> <id>5698</id> <spisZnacka>INS 4/2008</spisZnacka> <cas>2008-01-02 12:49:37.000</cas> <udalost>Sdělení</udalost> <druhStavRizeni>NEVYRIZENA</druhStavRizeni> <isirUrl>https://isir.justice.cz/...</isirUrl> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl> </isirRecord> </isir> </report> </creditCheck>
Example for ISIR and Domicile risk subject
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </requestSubject> <report > <status>3</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <ic>701689523</ic> <isir> <isirRecord> <id>5698</id> <spisZnacka>INS 4/2008</spisZnacka> <cas>2008-01-02 12:49:37.000</cas> <udalost>Sdělení</udalost> <isirUrl>https://isir.justice.cz/...</isirUrl> <druhStavRizeni>NEVYRIZENA</druhStavRizeni> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl> </isirRecord> </isir> <domicileMunicipality > <ic>12345678</ic> <muniName>Obecní úřad Praha 6</muniName>> <fullAddress>Krátká 8/12, Praha, 30100</fullAddress> </domicileMunicipality> </report> </creditCheck>
Example for ISIR and Domicile risk subject
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </requestSubject> <report > <status>3</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <ic>701689523</ic> <isir> <isirRecord> <id>5698</id> <spisZnacka>INS 4/2008</spisZnacka> <cas>2008-01-02 12:49:37.000</cas> <udalost>Sdělení</udalost> <druhStavRizeni>NEVYRIZENA</druhStavRizeni> <isirUrl>https://isir.justice.cz/...</isirUrl> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl> </isirRecord> </isir> <domicileMunicipality > <muniName>Obecní úřad Praha 6</muniName>> <fullAddress>Krátká 8/12, Praha, 30100</fullAddress> </domicileMunicipality> </report> </creditCheck>
Example for ISIR and Domicile risk subject
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicReport</webMethod> <time>21.10.2011 8:43:36</time> <requestSubject> <subjectType>privatePerson</subjectType> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <address> <street>Krátká</street> <number>8</number> <city>Praha</city> <zip>10100</zip> </address> </requestSubject> <report > <status>3</status> <fullReportUrl>http//...</ fullReportUrl> <birthNumber>7710109856</birthNumber> <firstName>Jan</firstName> <surname>Novák</surname> <ic>701689523</ic> <isir> <isirRecord> <id>5698</id> <spisZnacka>INS 4/2008</spisZnacka> <cas>2008-01-02 12:49:37.000</cas> <udalost>Sdělení</udalost> <isirUrl>https://isir.justice.cz/...</isirUrl> <druhStavRizeni>NEVYRIZENA</druhStavRizeni> <dokumentUrl>https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1408981</dokumentUrl> </isirRecord> </isir> <domicileMunicipality > <ic>12345678</ic> <muniName>Obecní úřad Praha 6</muniName>> <fullAddress>Krátká 8/12, Praha, 30100</fullAddress> </domicileMunicipality> </report> </creditCheck>
Example for CEECR risk subject
<creditCheck version="1.0" encoding="utf-8" xmlns=""> <webMethod>GetSubjectBasicReport</webMethod> <time>2013-09-23T13:48:39.8516250+02:00</time> <requestId>0dd13aff-92c5-4615-adb8-de1dcf390399</requestId> <requestSubject><reportVersion>2</reportVersion> <subjectType>privatePerson</subjectType> <birthNumber>515603123</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <address> <street /> <number /> <city /> <zip /> </address> <idCard>112200350</idCard> <checkInExecutionRegistry>1</checkInExecutionRegistry> </requestSubject> <report> <status>4</status> <birthNumber>515603123</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <idCard>INVALID</idCard> <ceecr> <currentCredit>285.50</currentCredit> <causes> <cause> <code>016 EX 1337/07</code> <document>Nařízení exekuce:9.9.2010</document> <legal_name>Novák Antonín</legal_name> <birth_date>3.6.1951</birth_date> <address>Blíževedly 152, Blíževedly, 471 04</address> </cause> <cause> <code>124 EX 1310/08</code> <document>Nařízení exekuce:13.9.2010</document> <legal_name>Novák Antonín</legal_name> <birth_date>3.6.1951</birth_date> <address>Blíževedly 152, Blíževedly, 47104</address> </cause> </causes> </ceecr> </report> </creditCheck>
Example for Justitia CZ risk subject
<creditCheck version="1.0" encoding="utf-8"> <webMethod>GetSubjectBasicReport</webMethod> <time>2014-02-28T12:03:21.9553886+01:00</time> <requestId>342557e2-fb58-4808-8949-11b1ed37662a</requestId> <requestSubject xmlns=""> <reportVersion>2</reportVersion> <subjectType>privatePerson</subjectType> <birthNumber>675419/0344</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <address> <street /> <number /> <city /> <zip /> </address> <idCard>112200350</idCard> <checkInJustitiaCz>1</checkInJustitiaCz> </requestSubject> <report> <status>4</status> <birthNumber>6754190344</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <idCard>INVALID</idCard> <justitiaCzRecord> <paid_y_12>0</paid_y_12> <paid_n_12>0</paid_n_12> <v_12_Paid_y>1</v_12_Paid_y> <v_12_Paid_n>0</v_12_Paid_n> </justitiaCzRecord> </report> </creditCheck>
Example for the Involvemens section
The Involvement block element has new element with name nazevSubjektu . This element contains the name of the subject where the person involved.
<creditCheck version="1.0" encoding="utf-8"> <webMethod>GetSubjectBasicReport</webMethod> <time>2014-02-28T12:03:21.9553886+01:00</time> <requestId>342557e2-fb58-4808-8949-11b1ed37662a</requestId> <requestSubject xmlns=""> <reportVersion>2</reportVersion> <subjectType>privatePerson</subjectType> <birthNumber>675419/0344</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <address> <street /> <number /> <city /> <zip /> </address> <idCard>112200350</idCard> <checkInJustitiaCz>1</checkInJustitiaCz> </requestSubject> <report> <status>4</status> <birthNumber>6754190344</birthNumber> <firstName>Antonín</firstName> <surname>Novák</surname> <idCard>INVALID</idCard> <involvements> <involvement> <birthNumber /> <birthDate>24.10.1962</birthDate> <ic>12345678</ic> <nazev>člen představenstva</nazev> <nazevSubjektu>Bytové družstvo Úsvit</nazevSubjektu> </involvement> <involvement> <birthNumber /> <birthDate>24.10.1962</birthDate> <ic>12345679</ic> <nazev>jednatel</nazev> <nazevSubjektu>Firma, s.r.o.</nazevSubjektu> </involvement> <involvement> <birthNumber /> <birthDate>24.10.1962</birthDate> <ic>12345677</ic> <nazev>jednatel</nazev> <nazevSubjektu>Firma, s.r.o.</nazevSubjektu> <evidovanoDo>2014-07-13T00:00:00.0000000+02:00</evidovanoDo> </involvement> </involvements> </report> </creditCheck>
Error messages
This section is under development. But here is base envelope for it.
<creditCheck version="1.0" encoding="utf-8" > <webMethod>GetSubjectBasicRecord</webMethod> <time>28.7.2010 6:12:38</time> <error> <errorId>1ef6df0c-06b9-4dc2-a1b0-31a2ef133189</errorId> <message>01 - unknown subject type</message> </error> </creditCheck>
Element name | datatype | mandatory | Notice |
errorId | GUID as string | yes | Id for matching our error db inside |
message | string | yes | Short information about error. |
List of error messages.
error number | error description | Notice | |
01 | unknown subject type | Unknown subjekt type inside the <requestSubject> <subjectType>privatePerson</subjectType> element | |
02 | invalid input | Input request is not valid. |
Error messages for CEECR data
There are following error messages inside CEECR element:
101 - Nemáte povolený přístup k datům CEECR.
102 - CEECR endpoint error.
103 - Nepodarilo se ziskat data.
It means:
101 – error when your access to CEECR is disallowed
102 – error if the CEECR interface (third party interface) has error or is not working
103 – when our system has a problem when generating data. Exactly information is on demand. Error Id is necessary.
If you have question about error a 102 and a 103 you must identified error by error id everytime.
Example for error 102
<creditCheck version="1.0" encoding="utf-8" xmlns=""> <webMethod>GetSubjectBasicReport</webMethod> <time>2014-08-18T10:42:09.8941151+02:00</time> <requestId>fefdcf1e-847f-4495-96dd-1b3580832118</requestId> <requestSubject> <reportVersion>2</reportVersion> <subjectType>privatePerson</subjectType> <birthNumber>6055240279</birthNumber> <firstName>Drahuše</firstName> <surname>Andělová</surname> <address> <street>Ječná</street> <number>661</number> <city>Miretice u Klášterec nad Ohří</city> <zip>43151</zip> </address> <idCard>108254997</idCard> <checkInExecutionRegistry>1</checkInExecutionRegistry> </requestSubject> <report> <status>4</status> <birthNumber>6055240279</birthNumber> <firstName>Drahuše</firstName> <surname>Andělová</surname> <idCard>OK</idCard> <ceecr> <remaining_credit>0</remaining_credit> <currentCredit>0</currentCredit> <error> <errorId>6a16a542-9951-4d29-b1b0-2f32b45c652c</errorId> <message>102 - CEECR endpoint error.</message> <description>Kontaktujte administrátora Credit Check, s.r.o.</description> </error> </ceecr> </report> </creditCheck>
Important notices
This section is under development. But here is base envelope for it.
URL response inside - all links are URL encoded.