Page Comparison

This is a brief description of the API calls most commonly used by banks. For full details about the request and response payloads, se the swagger documentation.

Find settlement

There are multiple ways of querying the Settlement API for an existing settlement.

• Query by buyer - Finds settlements by buyers SSN,

• Query by buyer and property key - Finds settlements by buyers SSN and PropertyKey

• Get by financial source

  Status
  colour Green title New feature

  - a bank may query settlements where their org.no. has been used in bidding without knowing the buyers ID

• Get by unique identifier - Each settlement have a globally unique ID that may be used for getting a specific settlement.

Swagger documentation for finding a settlement

• Beta

• Production

Send intention

Deciding whether to generate a digital or paper pantedokument (mortgage document)

Intention from Bank

The bank will assess a settlement, and provide an intention. The intention contains information whether the bank supports a digital flow or not as well as priority and amount information.

Note that the intention itself does not contain the mortgage documentation

Swagger documentation for Intention from Bank

• Beta

• Production

Example request body:

{
    "capability": {
        "flow": "DIGITAL"
    }
}

Intention from Bank on non-existent settlement

For brokers not using Ambita’s services there will not exist any settlements when searching. In these cases, you can still communicate your intention and send the mortgage document to the broker, but the sequence of events are a bit different.

To be able to get the broker’s intention, you must first send the bank’s intention. You must therefore produce a full, more complex intention containing both the broker’s organizationID, the property and one or more of the buuyers to be able to send it. The response will contain a reference to a settlement, either from the broker (if match is found) or a created proxy settlement as described here.

This could be for all cases, as is searches for settlements first. However it requires more data. This could be used in a combination with the search for settlement for avoid requesting unnecessary information from the users, like brokers organizationID and properties.

Provide mortgage document

The document resource is used by the bank to upload mortgage documents. If a settlement was found in step two, the settlementuid should be given as a query parameter. The mortgage document will then be included in that settlement. For settlements not known to EPS, it is possible to give the broker’s organization number in the request body, and if EPS is not able to identify a settlement, the mortgage document will be uploaded to Afpant. This enable banks to collaborate with brokers even if the broker is not using Ambita’s services for electronic registration and settlement services.

For customers integrating etinglysing.no, this step is handled by “send to broker”.

Add attachment

Attachments are documents that relate to a document resource, like a prerequisite/term document. The resource has its own endpoint, but must be linked to the document.

For customers integrating etinglysing.no, this step handled by “send prerequisites”.