Getting Started

Test environment

To get started there is a test environment where you can verify your technical solution. You can find more information and details in the reference guide. You can also order specific test scenarios by contacting UC.

Authentication

When you order the service you will be provided with a username and password which you will use to authenticate with the service.

The username and password is specified in the message.

Example call with authentication

The following example shows how you can login to the service by specifying the userid and password in the message.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:identityCheckPersonRequest uc:language="?" xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
      <uc:customer>
        <uc:userId>YOUR-USERID</uc:userId>
        <uc:password>YOUR-PASSWORD</uc:password>
      </uc:customer>
      <uc:countryCode>
        <uc:value>FI</uc:value>
      </uc:countryCode>
      <uc:personalNumber>
        <uc:year>50</uc:year>
        <uc:month>11</uc:month>
        <uc:day>06</uc:day>
        <uc:sequenceNumber>069v</uc:sequenceNumber>
      </uc:personalNumber>
    </uc:identityCheckPersonRequest>
  </soap:Body>
</soap:Envelope>

Usage

The API can be used for either searching or retrieving credit reports on individuals in the Nordic region.

Searching for a person

The following example showcases searching for a person by name and birthdate in Norway.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <ucc:personSearchRequest ucc:language="eng"
xmlns:ucc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10"> <ucc:customer> <ucc:userId>YOUR-USERID</ucc:userId> <ucc:password>YOUR-PASSWORD</ucc:password> </ucc:customer> <ucc:countryCode> <ucc:value>NO</ucc:value> </ucc:countryCode> <ucc:personRequestItem> <ucc:name> <ucc:firstName>Petra</ucc:firstName> <ucc:sureName>Testdame</ucc:sureName> </ucc:name> <ucc:personalNumber> <ucc:year>65</ucc:year> <ucc:month>10</ucc:month> <ucc:day>18</ucc:day> </ucc:personalNumber> </ucc:personRequestItem> </ucc:personSearchRequest> </soap:Body> </soap:Envelope>

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportReply/2008-12-10">
      <uc:status uc:result="ok" />
      <uc:ucReport>
        <uc:xmlReply>
          <uc:reports uc:lang="swe">
            <uc:report uc:id="0000TESTDA" uc:index="0" uc:name="" uc:styp="INSV">
              <uc:group uc:id="W250" uc:index="1" uc:key="18106500076" uc:name="">
                <uc:term uc:id="W25001" uc:name="">18106500076</uc:term>
                <uc:term uc:id="W25002" uc:name="">Testdame Petra</uc:term>
                <uc:term uc:id="W25003" uc:name="">Sofienberggate 56</uc:term>
                <uc:term uc:id="W25004" uc:name="">0563</uc:term>
                <uc:term uc:id="W25005" uc:name="">Oslo</uc:term>
                <uc:term uc:id="W25006" uc:name="">NO</uc:term>
                <uc:term uc:id="W25011" uc:name="">037</uc:term>
                <uc:term uc:id="W25012" uc:name="">181065</uc:term>
              </uc:group>
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soapenv:Body>
</soapenv:Envelope>

Identity check

The following example showcases performing an identity check on a person given a social security number.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:identityCheckPersonRequest uc:language="?"
xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10"> <uc:customer> <uc:userId>YOUR-USERID</uc:userId> <uc:password>YOUR-PASSWORD</uc:password> </uc:customer> <uc:countryCode> <uc:value>FI</uc:value> </uc:countryCode> <uc:personalNumber> <uc:year>50</uc:year> <uc:month>11</uc:month> <uc:day>06</uc:day> <uc:sequenceNumber>069v</uc:sequenceNumber> </uc:personalNumber> </uc:identityCheckPersonRequest> </soap:Body> </soap:Envelope>

Reply

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportReply/2008-12-10">
      <uc:status uc:result="ok" />
      <uc:ucReport>
        <uc:xmlReply>
          <uc:reports uc:lang="swe">
            <uc:report uc:styp="INSV" uc:name="" uc:index="0" uc:id="0000">
              <uc:group uc:name="" uc:key="642172" uc:index="1" uc:id="W250">
                <uc:term uc:name="" uc:id="W25001">061150069v</uc:term>
                <uc:term uc:name="" uc:id="W25002">Keski-Vahala Juho
Tapani</uc:term>
                <uc:term uc:name="" uc:id="W25003">Kalliontie 24 A
4</uc:term>
                <uc:term uc:name="" uc:id="W25004">85500</uc:term>
                <uc:term uc:name="" uc:id="W25005">Nivala</uc:term>
                <uc:term uc:name="" uc:id="W25006">FI</uc:term>
                <uc:term uc:name="" uc:id="W25011">037</uc:term>
                <uc:term uc:name="" uc:id="W25012">642172</uc:term>
              </uc:group>
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soap:Body>
</soap:Envelope>

Person report

The following example showcases requesting a credit report on a person in Finland given an object id.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:personReportRequest xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10"
uc:xmlReply="true" uc:htmlReply="false" uc:language="eng"> <uc:customer> <uc:userId>YOUR-USERID</uc:userId> <uc:password>YOUR-PASSWORD</uc:password> </uc:customer> <uc:countryCode> <uc:value>FI</uc:value> </uc:countryCode> <uc:productPersonCode> <uc:value>CONSUMER</uc:value> </uc:productPersonCode> <uc:template> <uc:templateId> </uc:templateId> </uc:template> <uc:objectId>549066</uc:objectId> <uc:extendedReportRequest> <uc:purpose>CREDITCHECK</uc:purpose> <uc:newCustomer> </uc:newCustomer> <uc:endUser> </uc:endUser> </uc:extendedReportRequest> </uc:personReportRequest> </soap:Body> </soap:Envelope>

Reply

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportReply/2008-12-10">
      <uc:status uc:result="ok" />
      <uc:ucReport>
        <uc:xmlReply>
          <uc:reports uc:lang="eng">
            <uc:report uc:styp="130" uc:name="Karkkainen Marko Reijo Kristian" uc:index="0" uc:id="549066">
              <uc:group uc:name="ID particulars" uc:key="" uc:index="0" uc:id="W080">
                <uc:term uc:name="" uc:id="W08001">010378</uc:term>
                <uc:term uc:name="" uc:id="W08003">Karkkainen Marko Reijo
Kristian</uc:term>
                <uc:term uc:name="" uc:id="W08004">Uotinkuja 4 AS 2</uc:term>
                <uc:term uc:name="" uc:id="W08005">38200</uc:term>
                <uc:term uc:name="" uc:id="W08006">Vammala</uc:term>
                <uc:term uc:name="" uc:id="W08043">No info</uc:term>
                <uc:term uc:name="" uc:id="W08009">00</uc:term>
                <uc:term uc:name="" uc:id="W08012" />
                <uc:term uc:name="" uc:id="W08010">00</uc:term>
                <uc:term uc:name="" uc:id="W08013" />
                <uc:term uc:name="" uc:id="W08011">00</uc:term>
                <uc:term uc:name="" uc:id="W08014" />
                <uc:term uc:name="" uc:id="W08045">FI</uc:term>
                <uc:term uc:name="" uc:id="W08046">SEK</uc:term>
                <uc:term uc:name="" uc:id="W08047">EUR</uc:term>
              </uc:group>
              <uc:group uc:name="Judgements, specified" uc:key="" uc:index="0" uc:id="W615">
                <uc:term uc:name="" uc:id="W61501">Insolvent.</uc:term>
                <uc:term uc:name="" uc:id="W61502">200811</uc:term>
                <uc:term uc:name="" uc:id="W61503">0000005503</uc:term>
                <uc:term uc:name="" uc:id="W61504" />
                <uc:term uc:name="" uc:id="W61506">L05</uc:term>
              </uc:group>
              <uc:group uc:name="Judgements, specified" uc:key="" uc:index="1" uc:id="W615">
                <uc:term uc:name="" uc:id="W61501">Insolvent.</uc:term>
                <uc:term uc:name="" uc:id="W61502">200810</uc:term>
                <uc:term uc:name="" uc:id="W61503">0000005624</uc:term>
                <uc:term uc:name="" uc:id="W61504" />
                <uc:term uc:name="" uc:id="W61506">L05</uc:term>
              </uc:group>
              <!-- ... -->
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soap:Body>
</soap:Envelope>

RetriveMetaData

The following details an example of fetching metadata via the API.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:retriveMetaDataRequest xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
      <uc:customer>
        <uc:userId>YOUR-USERID</uc:userId>
        <uc:password>YOUR-PASSWORD</uc:password>
      </uc:customer>
    </uc:retriveMetaDataRequest>
  </soap:Body>
</soap:Envelope>

Reply

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <uc:retriveMetaDataResponse xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
      <uc:productPersonCode>
        <uc:value>CONSUMER</uc:value>
      </uc:productPersonCode>
      <uc:productPersonCode>
        <uc:value>MICRO</uc:value>
      </uc:productPersonCode>
      <uc:productCompanyCode>
        <uc:value>STANDARD</uc:value>
      </uc:productCompanyCode>
      <uc:productCompanyCode>
        <uc:value>MINI</uc:value>
      </uc:productCompanyCode>
      <uc:productCompanyCode>
        <uc:value>RISK</uc:value>
      </uc:productCompanyCode>
      <uc:countryCode>
        <uc:value>FI</uc:value>
      </uc:countryCode>
      <uc:countryCode>
        <uc:value>DK</uc:value>
      </uc:countryCode>
      <uc:countryCode>
        <uc:value>NO</uc:value>
      </uc:countryCode>
    </uc:retriveMetaDataResponse>
  </soap:Body>
</soap:Envelope>

Errors

The following example showcases how a fault would look when received from the system.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <soap:Fault>
      <faultcode>soap:Server</faultcode>
      <faultstring>se.uc.webservice.uccreditreportservice.InvalidCountryCodeFault:</faultstring>
      <detail>
        <uc:invalidCountryCodeFault xmlns:uc="http://www.uc.se/schemas/ucCreditReportReply/2008-12-10">
          <uc:faultInfo>The country code provided is invalid</uc:faultInfo>
          <uc:message>The following country code are valid FI DK NO</uc:message>
        </uc:invalidCountryCodeFault>
      </detail>
    </soap:Fault>
  </soap:Body>
</soap:Envelope>