After generating a document, it needs to be signed according to the rules for that document type. When it is signed you can:
Set SDO (set the signed document back into the service
Set SDO list (set a list of signed document back into the service
Tinglys (Set SDO and register into the land registry directly)
Tinglys list (Set SDO list and register into the land registry directly)
Send to broker (Set SDO send the document to the brokers settlement)
Set SDO
In this scenario, there are some prerequisites:
The unsigned document is generated by etinglysing.
The document is signed by required parties
Set SDO The integrator initiates the process by sending a SDO to www.etinglysing.no, with the documents unique ID in etinglysing as input.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dok="http://dokument.ws7.etinglysing.no/"> <soapenv:Header/> <soapenv:Body> <dok:setSDO> <documentId>12345</documentId> <sdo>Byte64 representation</sdo> </dok:setSDO> </soapenv:Body> </soapenv:Envelope>
Example response
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/"> <ns2:return> <status> <created>2018-08-02T14:00:09.205+02:00</created> <documentStatusTinglysing/> <id>45721524</id> <statusCode>SIGNERT</statusCode> </status> <type>PANTEDOKUMENT</type> <documentVersion>KARTVERKET</documentVersion> </ns2:return> </ns2:getStatusResponse> </soap:Body> </soap:Envelope>
Alternative flow Set sdo - Error in provided SDO
In this case the web service has detected an error, due to an invalid SDO or that the content is changed from what was generated. In this case the response will indicate the error. The document will not be updated with the received SDO, which will be reflected in the document status.
Set SDO as list
This scenario is equal to the setSDO function, but enables the integrator to send multiple SDOs in a list, and return multiple responses.
Tinglys
In this scenario, there are some prerequisites:
The set sdo-service must have been executed with successful result
Tinglys The integrator initiates the process by requesting www.etinglysing.no with the document’s unique ID in etinglysing as input.
www.etinglysing.no will return a document status
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/"> <ns2:return> <status> <created>2018-08-02T14:00:09.205+02:00</created> <documentStatusTinglysing/> <id>45721524</id> <statusCode>UNDER_TINGLYSING</statusCode> </status> <type>PANTEDOKUMENT</type> <documentVersion>KARTVERKET</documentVersion> </ns2:return> </ns2:getStatusResponse> </soap:Body> </soap:Envelope>
The actual tinglys-process at Statens Kartverk is an asynchronous process which will take some time. The response from the tinglys web service indicates that the process has started successfully. To verify the complete result, the integrator must request for status until status is tinglyst or tinglysing-feilet (see chapter 6.6.1 in page 28). The result will normally be available after three days for pantedokument, two days for cancellations.
Alternative flow Tinglys – Tinglysing with error
If an exception occurs during Tinglys, an error response will be returned. The response contains detailed error information. To request for status please use the Get status request.
Document status will either be:
‘Tinglysing feilet’: The document has been processed and will not be registered.
‘Signert’ or ‘Part signert’: In this case, you can try again.
Send to broker
Collaboration with broker
Our collaboration service Electronic Property Settlement (Elektronisk Eiendomsoppgjør), enables collaboration between bank and broker. This enables a bank to send the mortgage document to the broker for registration in the Land Registry, as part of a document package, together with the deed, which enables use of digital documents in the process of buying a house(realty). To do so we have implemented the possibility to generate documents for the future owner (buyer) so that, together with the deed, it will both change ownership and establish collateral for the bank, via the broker/real-estate agent.
Figure 7 Collaboration overview
sendToBroker( long documentID, Base64 sdo, Base64 priorityPrerequisiteDocument, String epsSettlementID, String altinnOrganizationID )
Input:
DocumentID | The unique id returned from the generate action |
---|---|
SDO | (optional) The Signed Data Object representation of the document. Could also be set in any of the actions the sets the SDO back to us; setSDO or setSDOList. |
Priority Prerequisite Document | (optional) The terms from the bank to the broker as PDF or as an xml document according to the standard defined by DSVE If the |
EPS Settlement ID | (optional) Explicit ID of the settlement selected in advance. To further benefit from the EPS services, the bank may utilize the content of the EPS settlement earlier in the loan process. If the coupling has already taken place, this can be used to dictate www.etinglysing.no were to send the document |
Altinn Organization ID | (optional) This is the organization number of the broker that only is available through the Altinn Formidlingstjeneste. When this field contains a valid organization number it will attempt to send the document to the broker. Currently this service is a one-way street from the bank to the broker to enable registration of deeds/packages. If the |
This service requires the documentID from the generate call, the signed version of that document and the pre-requisites pdf-bytes (optional). When called www.etinglysing.no will push the signed document to the relevant EPC settlement, if found. The document would be coupled to the relevant EPS settlement at any time in its lifetime. If no settlement process is found at the time of creation, this service will try to do the coupling based on the content of the document.
Note that there is no need to generate a foelgebrev for a document that is to be sent to the broker, as this will be done by the broker.
Send prerequisites
sendPriorityPrerequisiteDocumentToBroker( long documentID, byte64 priorityPrerequisiteDocument )
Input:
DocumentID | The unique id returned from the generate action |
---|---|
Priority Prerequisite Document | The terms from the bank to the broker as PDF |
This service only sends the prerequisites to the broker through EPS.
Get status
The integrator initiates the process by requesting www.etinglysing.no with the document’s unique ID in etinglysing as input. www.etinglysing.no will return a document status
Example request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dok="http://dokument.ws7.etinglysing.no/"> <soapenv:Header/> <soapenv:Body> <dok:getStatus> <documentId>1234567</documentId> </dok:getStatus> </soapenv:Body> </soapenv:Envelope>
Example response:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getStatusResponse xmlns:ns2="http://dokument.ws7.etinglysing.no/"> <ns2:return> <status> <created>2018-08-02T14:00:09.205+02:00</created> <documentStatusTinglysing/> <id>45721524</id> <statusCode>SIGNERT</statusCode> </status> <type>PANTEDOKUMENT</type> <documentVersion>KARTVERKET</documentVersion> </ns2:return> </ns2:getStatusResponse> </soap:Body> </soap:Envelope>
Alternative flow Get status - Non-existing reference
www.etinglysing.no cannot return status, due to a non-existing document id. The document does not exist.
Get status of an assignment (oppdrag)
The integrator initiates the process by requesting www.etinglysing.no with the oppdrag’s unique ID in etinglysing as input. The response will be:
oppdragsNr: unique String
oppdragsId: unique ID in etinglysing (same as input)
epsSettlementId: unique EPS ID if exists
documentStatusList: list of document statuses for all documents that exists on this oppdrag
Figure 8 Example of response from getOppdragStatus operation
Get artifact
The artifacts are available at different stages. The different stages and artifacts available, are listed in the table below.
Document status | Artifact |
---|---|
PART_SIGNERT SIGNERT UNDER_TINGLYSING TINGLYSING_FEILET FJERNET_FRA_TINGLYSING | ALLE, DOKUMENT |
TINGLYST |
DOKUMENT is the signed data object (SDO).
Monitoring events
Every major change on a document is recorded as an event (hendelse). For monitoring a portfolio of document, events will give you a good way to handle post processing.
List events
«listHendelser» returns a list of events from the given eventid (fraHendelsesId). The service takes a list of parameter to limit the result.
Params:
Parameter | Description |
---|---|
fraHendelsesId | eventid to start from |
maxAntall | maximum number of events |
statuser | limit to certain WsDokumentStatus-types |
typer | event types as defined in WsHendelsesType |
kunEksterne | True: Only documents created by using the DocumentWS. |
Response:
Type | Description |
---|---|
id | event id |
type | one of WsHendelsesType |
dokumentId | documentid in www.etinglysing.no |
eksternEierId | document owner |
nyStatus | new status |
gammelStatus | old status |
beskrivelse | status description in Norwegian |
opprettet | event date |
eksterntOpprettetDokument | document is created by using DocumentWS |
dokumentRef | the document reference at the event time |
oppdragsId | oppdragsid in www.etinglysing.no |
List events with status
«listHendelserMedStatus» returns a list of events from the given eventID (fraHendelsesId). Attached to each event is the status of the document, as delivered in getStatus.
Create broker assignments
The Oppdrag service has only one operation; leggTilDokumentGrunnlag. This takes key information to create a baseline for continue working in etinglysing, with single sign on.
Create/Update assignment
The action will put relevant information over to www.etinglysing.no, easing the process of document creation, signing an tinglysing. The response is a unique id representing the oppdrag/assignment. This can be used for creating the correct URL to go directly to the Oppdrag in etinglysing.no. Consecutive calls with the same information will update the Oppdrag. The unique key for the oppdrag is oppdragsnr (the number used by the broker to identify a assignment)
Oppdrag model
Example:
<opp:dokumentGrunnlag oppdragsnr="123654poi123lkj"> <dok:panteopplysninger> <dok:fullsignert>true</dok:fullsignert> <dok:pantebeloep valuta="NOK" verdi="100000"/></dok:panteopplysninger> <dok:omsetningsopplysninger> <dok:omsetningsnr>00003-00</dok:omsetningsnr> <dok:omsetningsType>FRITT\_SALG</dok:omsetningsType> <dok:utlystTilSalgPaaDetFrieMarked>true</dok:utlystTilSalgPaaDetFrieMarked> <dok:kjoepesum>150000</dok:kjoepesum> <dok:avgiftsgrunnlag>0</dok:avgiftsgrunnlag> <dok:aarsak>HOVEDREGEL</dok:aarsak> </dok:omsetningsopplysninger> <dok:borettsandel orgnr="932305364" andelsnr="9" borettslagnavn="BAS"> <dok:selgere> <dok:hjemmelshaver teller="1" nevner="1"> <ret:person id="12345678901"> <ret:fornavn>Thomas</ret:fornavn> <ret:etternavn>Normann</ret:etternavn> <ret:epost>test@example.com</ret:epost> </ret:person> </dok:hjemmelshaver> </dok:selgere> <dok:kjoepere> <dok:kjoeper teller="1" nevner="1"> <ret:person id="1245678901"> <ret:fornavn>Kai</ret:fornavn> <ret:etternavn>Normann</ret:etternavn> </ret:person> </dok:kjoeper> </dok:kjoepere> </dok:borettsandel> </opp:dokumentGrunnlag>
Sso
The SSO (Single Sign On) endpoint enables the integrator to create a token URI that pre-authenticates the user, so that the user can navigate directly to the oppdrag/document requested.
The endpoint serves to actions:
MakeTokeUrls
This action takes the documentID or oppdragID as input. The user authenticated will be the user authenticated in the SOAP call. The response gives the following:
Name | Description |
---|---|
meglerOppdrag | Url to the oppdrag (Example: https://www.etinglysing.no/megler/oppdrag/231.form?token=abc321 |
meglerOppdragsListe | Url to the search opppdrag page. (Example: https://www.etinglysing.no/megler/oppdrag.form?token=abc123) |
tokenKey | The token(Example: 1so4NmpPKXWgVCQ6nZKWzA%3D%3D) |
validUntillGmtMs | The timestamp when token expires |
InvalidateToken
A service that invalidates a generated token. It only takes the token provided in the “makeTokenUrls” action.
Types
The web-services will return one of the elements listed below.
DokumentResponse | Document status and document holders |
---|---|
StatusResponse | Document status |
ArtifaktResponse | A list of artefacts |
UrlResponse | A list of document urls |
The basic element is described in the following chapters.
Document status
Id | Document id in www.etinglysing.no. |
---|---|
Current state for the document. | |
The object reflects what is registered in the Land Registry |
Each of the systems has its own document number series. To uniquely identify a document at the registration office you need system, year of registration and official document number.
Status/State
OPPRETTET | A document without a SDO |
---|---|
PART_SIGNERT | The document contains a SDO, signed by the title holder(s) but not by the sender of the document (rekvirent) |
UNDER_SIGNERING | The signing process has started but is not completed |
SIGNERT | All parties have signed the SDO. The document is ready for registration. |
FJERNET_FRA_SIGNERING | The document is removed from the signing process. V3 only. |
UNDER_TINGLYSING | The document has been sent for registration at Tinglysingsmyndigheten. |
TINGLYST | The document is confirmed registered with a successful result. |
TINGLYSING_FEILET | The document failed in registration. |
FJERNET_FRA_TINGLYSING | The document has been removed before it was registered. |
SLETTET | The document has been deleted from www.etinglysing.no. |
SENDT_TO_BROKER | The document is sent to broker for registration. |
Status transitions
From status | Action | To status |
---|---|---|
Generate pantedokument | OPPRETTET | |
Generate foelgebrev | OPPRETTET | |
OPPRETTET | Set SDOList (with both document and foelgebrev) | SIGNERT |
Alt. | ||
OPPRETTET | Set SDO | SIGNERT |
SIGNERT | Tinglys | UNDER_TINGLYSING TINGLYST TINGLYSING_FEILET |
SIGNERT | Send to broker | SENDT_TO_BROKER |
SENDT_TO_BROKER | ”Update from broker” | TINGLYST TINGLYSING_FEILET |
UNDER_TINGLYSING | CancelTinglys | FJERNET_FRA_TINGLYSING |
OPPRETTET | Tinglys Sdo | UNDER_TINGLYSING TINGLYST TINGLYSING_FEILET |
Alle | Get status | Does not change status |
Alle | Get artefact | Does not change status |
Document holder
Type | |
---|---|
Format | |
Content | byte array containing the document itself |
Artifakt
Dokument id | Document id in www.etinglysing.no. |
---|---|
Type | |
ArtifakterInBytes | byte array containing the artefact. |
This is only available for documents sent to the new
Artifact type
DOKUMENT | The document itself |
---|---|
PANTEATTEST | The former type of receipt from Kartverket |
OMSLAG (historical) | A historic type (not used anymore) |
GRUNNBOKSUTSKRIFT | The receipt showing a snapshot of Grunnboken after tinglysing operation |
Artifact scope
ALLE | All available atifacts |
---|---|
DOKUMENT | Document artifacts |
PANTEATTEST | Panteattest artifacts |
GRUNNBOKSUTSKRIFT | Only grunnboksutskrift |
OMSLAG | Only omslag |
RECEIPT | Both PANTEATTEST or GRUNNBOKSUTSKRIFT |
Document format
BIDXML | An XML structure to be used as input to BankID signing |
---|---|
SDO | A Signed Data Object defined by the SEID-SDO standard |
Portable document format | |
TEXT | Plain text |
Document type
PANTEDOKUMENT | Mortgage document |
---|---|
SLETTING | Deletion document |
FOELGEBREV | Slip/Envelope for registration process |
SKJOETE | Change of ownership |
Document status tinglysing
DokumentNr | The official document number assigned by the registration. |
---|---|
DokumentAar | The official registration year for the document. |
Embete | The office number |
Foeringsdag | The official registration date for the document. |
Foeringstidspunkt | The official registration time for the document. |
System | BORETT or EIENDOM |
List of Rettsstiftelser | A list of rettstiftelser within the registered document (rettsstiftelsesnummer, dokumenttypetekst and dokumenttypekode) |
Document url
Type | Valid value is DOCUMENT |
---|---|
Url | The document url. |
Definitions
Concept/Term | Description |
---|---|
Artefact/artifact | Documents returned from Statens Kartverk as a result of successful land registration. The type of artefact depends on the document registered. |
BankID | Online service for secure identification and electronic signing of documents. |
Elektronisk tinglysing | |
Ambita´s system for electronic registration (land registration, mortgages and corresponding cancellation). | |
Integrator | Bank og broker system |
Panteattest | A signed document returned by Statens Kartverk after a successful ‘tinglysing’ of a ‘pantedokument’ |
Pantedokument | A type of document typically used by banks to get security in a property for loans. |
SDO | Signed Data Object |
SSO | Single Sign On. A technical solution that enables users to log on to eTinglysing without entering username and password. |
Statens Kartverk | Owner of the land register |
Solution for signing documents electronically using BankID | |
SK-API | The Mapping authorities are creating a new system for tinglysing/registering which will deployed to production in September 2016 |
Følgebrev | Slip to be part of the shipment when registering document to Statens Kartverk |
Tinglys / Tinglysing | Norwegian term for land registration |
LR | Land Registry |
EPS | Electronic Settlement Process (Elektronisk Eiendomsoppgjør) |
Skjøte | A type of document used for changing owners of property |
Oppdrag | Placeholder for a group of related documents, often used by brokers |
Retinglysing | An addon (påtegning) prolonging the validity of a document |