Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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..

Code Block
titleSOAP header
<soap:Header>
<CreditCheckHeader
xmlns="http://creditcheck.cz/">
<Login>string</Login>
<Password>string</Password>
</CreditCheckHeader>
</soap:Header>

...

WSDL bellow will be available on url http://creditwebservices.creditcheck.cz/CreditCheckAktualizace.asmx?op=GetSubjectBasicReport

SOAP 1.1

...

themeConfluence
titleSOAP 1.1.

...

Metoda GetSubjectBasicReport (GSBR) je používána pro prověřování fyzických osob (tzn. osoby nepodnikající). Na jejím vstupu je potřeba uvést minimálně následující informace o osobě:

  • Jméno
  • Příjmení
  • RČ nebo Datum narození
  • Bydliště


Info

JPDN je zkratka pro identifikátor definovaný pomocí hodnot: Jméno, Příjmení, Datum narození.



na základě těchto vstupních parametrů, můžete z metody obdržet následující informace:

  • insolvence dle RČ (případně JPDN)
    • insolvence jsou dohledávány primárně podle RČ pokud je k dispozici.
    • V případě, že RČ není k dispozici nebo podle něho nebyla dohledána žádná insolvence, potom je vyhledávání prováděno podle JPDN.
  • bydliště na úřadě
    • je nutné vyplnit kompletní adresu bydliště (tzn. ulice, čp, město, psč)
    • Ve výstupu je uvedeno v elementu: <domicileMunicipality> (pokud je nalezena shoda)
  • vlastnictví nemovitosti
    • data metoda vrací pouze v případě, že je nepovinný parametr <checkInRealEstate>1</checkInRealEstate >  nastaven na hodnotu 1 (True)
    • pro toto prověření, je nutné aby uživatel byl kreditovým zákazníkem. Tzn. aby v rámci systému Creditcheck jeho účet disponoval kreditním zůstatkem.
    • dotaz je prováděn pomocí JPDN. Tzn. dotaz není prováděn podle RČ !
      • z principu věci může ve výsledku prověření být shoda podle jména, příjmení, data narození
  • platný občanský průkaz    
    • Data metoda vrací pouze pokud je vyplněn parametr: <idCard>XXXXXXXXXX</idCard>
    • Id card představuje ID dokladu (občanský průkaz)
    • Výsledek prověření říká pouze jestli daný doklad je nebo není validní. (OK / INVALID)
  • dluhy na zdravotním pojištění
    • Z důvodu GDPR, již zdroje neposkytují detailní informace o klientech, proto metoda nadále neposkytuje dlužnická data o fyzických osobách
  • CEE
    • Data metoda vrací, pouze pokud je nepovinný parametr:   <checkInExecutionRegistry>1</checkInExecutionRegistry> nastaven na hodnotu 1 (True).
    • Tento dotaz je zpoplatněný, uživatel tedy musí disponovat kreditním zůstatkem.
    • Prověřování je vždy prováděno na základě JPDN.
  • JustitiaCZ
    • Data z důvodu ukončení zdroje informací již nadále metoda neposkytuje


Warning

Doporučujeme při každém volání nastavovat parametr <reportVersion> na hodnotu = 3, která je nejaktuálnější a vrací kompletní data.

SOAP header:

Credit check SOAP header, obsahuje přihlašovací údaje uživatelského účtu který provádí dotaz.

Warning

Pozor, přihlašovací údaje účtu použité v této hlavičce slouží k identifikaci účtu z kterého bude stržen kredit za placené dotazy.


Code Block
titleSOAP header
<soap:Header>
<CreditCheckHeader
xmlns="http://creditcheck.cz/">
<GetSubjectBasicReportResult>xml<<Login>string</GetSubjectBasicReportResult>Login>
<<Password>string</GetSubjectBasicReportResponse>Password>
</soap:Body>CreditCheckHeader>
</soap:Envelope>:Header>


WSDL

WSDL bellow will be available on url http://creditwebservices.creditcheck.cz/CreditCheckAktualizace.asmx?op=GetSubjectBasicReport

SOAP 1.

...

1

Code Block
themeConfluence
titleSOAP 1.21.
POST /CreditCheckWebServices/CreditCheckAktualizace.asmx HTTP/1.1
Host: creditwebservices.creditcheck.cz
Content-Type: applicationtext/soap+xml; charset=utf-8
Content-Length: length
SOAPAction: "http://creditcheck.cz/GetSubjectBasicReport"


<?xml version="1.0" encoding="utf-8"?>
<soap12<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12soap="http://wwwschemas.w3xmlsoap.org/2003soap/05envelope/soap-envelope">
<soap12<soap:Header>
<CreditCheckHeader xmlns="http://creditcheck.cz/">
<Login>string</Login>
<Password>string</Password>
</CreditCheckHeader>
</soap12soap:Header>
<soap12<soap:Body>
<GetSubjectBasicReport xmlns="http://creditcheck.cz/">
<subjectData>xml</subjectData>
</GetSubjectBasicReport>
</soap12soap:Body>
</soap12soap:Envelope>
HTTP/1.1 200 OK
Content-Type: applicationtext/soap+xml; charset=utf-8
Content-Length: length


<?xml version="1.0" encoding="utf-8"?>
<soap12<soap: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:soap="http://creditcheck.cz/">
<GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult>
</GetSubjectBasicReportResponse>
</soap12:Body>
</soap12:Envelope>

Requests to webmethod - input parameter description

Type 1: request for private person

Code Block
titleprivate person request
<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>schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSubjectBasicReportResponse xmlns="http://creditcheck.cz/">
<GetSubjectBasicReportResult>xml</GetSubjectBasicReportResult>
</GetSubjectBasicReportResponse>
</soap:Body>
</soap:Envelope>

Requests to webmethod - input parameter description


request for private person, version 3

...

Code Block
titleprivate person request
<requestSubject>
<reportVersion>3</reportVersion>
<subjectType>privatePerson</subjectType>
<birthNumber>8005161124</subjectType>birthNumber>
<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>
checkInExecutionRegistry >
<checkInRealEstate>1</checkInRealEstatecheckInRealEstate>
>
<checkInJustitiaCz>1</checkInJustitiaCz>
reportVersion
</requestSubject>

...

zip2

Element name

datatype

mandatory

reportVersionrelation

Notice

subjectType

string

yes

privatePerson

birthNumber

string

yes

birthDatestring

relation

3Is 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

Description

subjectType

string

yes



privatePerson

numberbirthNumber

string

yes

city



birthDatestring

yes

relation

3
Při zadání RČ je přesto důležité uvádět i Jméno a Příjmení hledané osoby. 

firstName

string

yes




idCardsurname

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

yes




address






street

string

yes




number

string

yes




city

string

yes




zip

string

yes




idCard

string

no

2

The reportVersion 2 only. When element exists and value is 1 than subject will check in the Execution database.


checkInRealEstateID dokladu který chcete prověřit. Typicky ID občanského průkazu.

reportVersion

string

no




checkInExecutionRegistry

string

no

The reportVersion 2 only. When element exists and value is 1 than subject will check in the Real estate database.
2

checkInRealEstate

string

no

2

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.

...

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


Note

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.

...

Code Block
titleExample for ISIR and Domicile and VZP 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>

...