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:Body xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
    <uc:companyReportRequest uc:htmlReply="false" uc:language="eng" uc:xmlReply="true">
      <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:productCompanyCode>
        <uc:value>STANDARD</uc:value>
      </uc:productCompanyCode>
      <uc:objectId>01120389</uc:objectId>
    </uc:companyReportRequest>
  </soap:Body>
</soap:Envelope>

Usage

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

Searching for a company

The following example showcases searching for a company by name in Finland.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
    <uc:companySearchRequest 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:companyRequestItem>
        <uc:name>nokia</uc:name>
      </uc:companyRequestItem>
    </uc:companySearchRequest>
  </soap:Body>
</soap:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/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="0000NOKIA">
              <uc:group uc:name="" uc:key="01120389"
                        uc:index="1" uc:id="W250">
                <uc:term uc:name="" uc:id="W25001">01120389</uc:term>
                <uc:term uc:name="" uc:id="W25002">Nokia Oyj</uc:term>
                <uc:term uc:name="" uc:id="W25003">Keilalahdentie 4</uc:term>
                <uc:term uc:name="" uc:id="W25004">02150</uc:term>
                <uc:term uc:name="" uc:id="W25005">Espoo</uc:term>
                <uc:term uc:name="" uc:id="W25006">FI</uc:term>
                <uc:term uc:name="" uc:id="W25007">+358-40-8254906</uc:term>
                <uc:term uc:name="" uc:id="W25011">017</uc:term>
              </uc:group>
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soap:Body>
</soap:Envelope>

Verifying the identity of a company

The following example showcases performing an identity check on a company given a organization number.

Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:identityCheckCompanyRequest 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:organizationNumber>01120389</uc:organizationNumber>
    </uc:identityCheckCompanyRequest>
  </soap:Body>
</soap:Envelope>

Reply

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/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="01120389" 
                        uc:index="1" uc:id="W250">
                <uc:term uc:name="" uc:id="W25001">01120389</uc:term>
                <uc:term uc:name="" uc:id="W25002">Nokia Oyj</uc:term>
                <uc:term uc:name="" uc:id="W25003">Keilalahdentie 4</uc:term>
                <uc:term uc:name="" uc:id="W25004">02150</uc:term>
                <uc:term uc:name="" uc:id="W25005">Espoo</uc:term>
                <uc:term uc:name="" uc:id="W25006">FI</uc:term>
                <uc:term uc:name="" uc:id="W25007">+358-40-8254906</uc:term>
                <uc:term uc:name="" uc:id="W25011">017</uc:term>
              </uc:group>
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soap:Body>
</soap:Envelope>

Request a credit report for a company

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:companyReportRequest 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:productCompanyCode> <uc:value>STANDARD</uc:value> </uc:productCompanyCode> <uc:template> <uc:templateId> </uc:templateId> </uc:template> <uc:objectId>01120389</uc:objectId> </uc:companyReportRequest> </soap:Body> </soap:Envelope>

Reply

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header />
  <soap:Body>
    <uc:ucReply xmlns:uc="http://www.uc.se/schemas/ucCreditReportRequest/2008-12-10">
      <uc:status uc:result="ok" />
      <uc:ucReport>
        <uc:xmlReply>
          <uc:reports uc:lang="eng">
            <uc:report uc:styp="140E" uc:name="Nokia Oyj" uc:index="0" uc:id="01120389">
              <uc:group uc:name="ID particulars" uc:key="" uc:index="0" uc:id="W010">
                <uc:term uc:name="" uc:id="W01001">01120389</uc:term>
                <uc:term uc:name="" uc:id="W01003">00045</uc:term>
                <uc:term uc:name="" uc:id="W01007">HELSINKI</uc:term>
                <uc:term uc:name="" uc:id="W01008">Limited company quoted</uc:term>
                <uc:term uc:name="" uc:id="W01009">3220</uc:term>
                <uc:term uc:name="" uc:id="W01011">Manufact of tv <!-- ... --></uc:term>
                <!-- ... -->
              </uc:group>
            </uc:report>
          </uc:reports>
        </uc:xmlReply>
      </uc:ucReport>
    </uc:ucReply>
  </soap:Body>
</soap:Envelope>

Fetch metadata

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-ID</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>