Start TeleID

The POST /v3/teleid endpoint is used to start a TeleID.

POST /v3/teleid
Authorization: Basic ${ base64(apiKey + ':' + secretKey) }

Parameter	Required	Description
provider	Yes	The eID provider to use. Can be one of: 'BANKID_SE', 'FREJA', 'BANKID_NO', 'VIPPS', 'MITID' or 'FTN'
method	Yes	The method to use for authentication. Can be one of: 'SSN', 'PHONE', 'EMAIL', 'CHAT'
ssn	No	The SSN of the end user for autostart. Required if method is SSN
country	No	The country associated with the SSN
callInitiator	No	The initiator of the authentication request. Required if method is SSN and provider is BANKID_SE. Can be one of: 'USER' or 'RP'
email	No	An email address for login link via email. Required if method is EMAIL
phone	No	A phone number for autostart or login link via SMS. Required if method is PHONE
language	No	The default language to use during authentication
agent	Yes	The agent to indentify as
agent.ssn	No	The SSN of the agent, if the agent is a eID user.
agent.country	No	The country associated with the given SSN, if any.
agent.username	No	The username of the agent, if the agent is a username/password user.
agent.nameId	No	The nameId of the agent, if the agent is a SSO user.

Response example:

Pending:

HTTP/2.0 200 OK

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "startedAt": "2022-01-26 13:05:40",
  "autoDeleteDate": "2022-07-25",
  "agent": {
    "name": "Firstname Lastname"
  },
  "status": "PENDING",
  "url": "https://example.com/authenticate",
  "bindingMessage": "Reference text"
}

Completed:

HTTP/2.0 200 OK

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "startedAt": "2022-01-26 13:05:40",
  "autoDeleteDate": "2022-07-25",
  "agent": {
    "name": "Firstname Lastname"
  },
  "status": "COMPLETED",
  "completedAt": "2022-01-26 13:05:40",
  "user": {
    "ssn": "YYYYMMDDXXXX",
    "country": "SWEDEN",
    "name": "Firstname Lastname"
  },
  "identification": {
    "provider": "BANKID_SE",
    "certStartDate": "2022-01-04",
    "orderRef": "f4c1d82e-e396-4c8b-bc52-5151bc019da5"
  }
}

Failed:

HTTP/2.0 200 OK

{
  "id": "1668b9da-bff1-4dfc-ad48-60507b5a8d12",
  "startedAt": "2022-01-26 13:05:40",
  "autoDeleteDate": "2022-07-25",
  "agent": {
    "name": "Firstname Lastname"
  },
  "status": "FAILED",
  "error": "Error"
}