Identify consumer

Identifying the consumer for Ecster is a two step process:

  1. Merchant identifies the consumer either by using a physical identity document or an electronic id. See all valid physical and electronic IDs here.
  2. Merchant sends information about the consumer and how the consumer was identified. Ecster returns a ticket which is bound to the identified consumer at Ecster. The ticket is then used in subsequent calls to Ecster to identify the consumer.

Electronic id

Identifying the consumer using an electronic identification is a multistep process. This identification method can be used both online and in a physical environment.

  1. Initialize identification against Ecster. Consumer’s ssn needs to be provided by merchant. Response contains an id and a poll time interval (how long will you need to wait before next status collect).
  2. Collect status on identification. Input is the id obtained in the initialization and output is, among other things, status of the identification. A poll time is returned, indicating how long you need to wait until next status collect. If the consumer is verified successfully, the id can be used to create a ticket to be able to create an order for this consumer.
See flowchart on electronic id below:

Electronic id flow chart

1. Initialize electronic identification

Call to begin consumer identification using an electronic id - BankID or mobile BankID.

POST /v1/identification/eid

x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/json

{
    "type": "SE_BANKID_MOBILE",
    "nationalId": "SE5305169756"
}

2 Handle the response

You can either get OK response, or an error.

The response contains following information:

  • id: identifier for this identification.
  • status: see here for statuses.
  • startURL: URL used to activate chosen eid client on consumer’s computer or mobile device. Only relevant when application and eid client reside on same device.
  • pollTime: time to wait until next poll, in milliseconds
  • name: will be supplied when status is COMPLETE.
  • nationalId: will be supplied when status is COMPLETE

Status: 201 created

{
    "id": "v5HjBADhxAcM4QnZR3wS",
    "status": "OUTSTANDING_TRANSACTION",
    "startURL": "bankid:///?autostarttoken=DUMMY-AUTOSTART",
    "pollTime": 5000
}

Here we got status OUTSTANDING_TRANSACTION and a poll time at 5000ms and that means we are going to make the collect call to check the status in 5000ms.

3. Collect electronic identification

You make the collect call with the id returned from Initialize electronic identification or Collect electronic identification.

Cal to collect status on the identification process.

GET /v1/identification/eid/v5HjBADhxAcM4QnZR3wS

x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/json

All request parameters have to submittet in the url. No message body should be sent in.

4. Handle the response

You can either get OK response, or an error.

The response contains following information:

  • id: identifier for this identification.
  • status: see here for statuses.
  • startURL:
  • pollTime: time to wait until next poll, in milliseconds
  • name: will be supplied when status is COMPLETE.
  • nationalId: will be supplied when status is COMPLETE.

Status: 200 OK

{
    "id": "v5HjBADhxAcM4QnZR3wS",
    "status": "COMPLETE",
    "pollTime": 1500,
    "name": {
        "firstName": "Algot",
        "lastName": "Henriksson"
    },
    "nationalId": "SE530516-9756"
}
Request test account