Class BankIdSeEndpoint

BankID SE operations.

Index

Constructors

Methods

ageVerification ageVerificationStatus auth authStatus cancelAgeVerification cancelAuth cancelSign phoneAuth phoneSign sign signStatus verify waitForAgeVerification waitForAuth waitForSign

Constructors

constructor

new BankIdSeEndpoint(client: IdkollenClient): BankIdSeEndpoint
Parameters
- client: IdkollenClient
Returns BankIdSeEndpoint
- Defined in src/endpoints/bankid_se.ts:17

Methods

ageVerification

ageVerification(req: AgeVerificationRequest): Promise<AgeVerificationStatus>
Start a BankID SE age verification session.
Parameters
- req: AgeVerificationRequest
Returns Promise<AgeVerificationStatus>
- Defined in src/endpoints/bankid_se.ts:45

ageVerificationStatus

ageVerificationStatus(id: string): Promise<AgeVerificationStatus>
Poll the current status of a BankID SE age verification session.
Parameters
- id: string
Returns Promise<AgeVerificationStatus>
- Defined in src/endpoints/bankid_se.ts:60

auth

auth(req: BankIdSeAuthRequest): Promise<BankIdSeStatus>
Start a BankID SE authentication session.
Parameters
- req: BankIdSeAuthRequest
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:20

authStatus

authStatus(id: string): Promise<BankIdSeStatus>
Poll the current status of a BankID SE authentication session.
Parameters
- id: string
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:50

cancelAgeVerification

cancelAgeVerification(id: string): Promise<void>
Cancel a BankID SE age verification session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/bankid_se.ts:75

cancelAuth

cancelAuth(id: string): Promise<void>
Cancel a BankID SE authentication session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/bankid_se.ts:65

cancelSign

cancelSign(id: string): Promise<void>
Cancel a BankID SE signing session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/bankid_se.ts:70

phoneAuth

phoneAuth(req: BankIdSePhoneAuthRequest): Promise<BankIdSeStatus>
Start a BankID SE phone authentication session.
Parameters
- req: BankIdSePhoneAuthRequest
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:25

phoneSign

phoneSign(req: BankIdSePhoneSignRequest): Promise<BankIdSeStatus>
Start a BankID SE phone signing session.
Parameters
- req: BankIdSePhoneSignRequest
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:35

sign

sign(req: BankIdSeSignRequest): Promise<BankIdSeStatus>
Start a BankID SE signing session.
Parameters
- req: BankIdSeSignRequest
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:30

signStatus

signStatus(id: string): Promise<BankIdSeStatus>
Poll the current status of a BankID SE signing session.
Parameters
- id: string
Returns Promise<BankIdSeStatus>
- Defined in src/endpoints/bankid_se.ts:55

verify

verify(req: BankIdSeVerifyRequest): Promise<BankIdSeVerifyResponse>
Verify a scanned BankID SE QR code.
Parameters
- req: BankIdSeVerifyRequest
Returns Promise<BankIdSeVerifyResponse>
- Defined in src/endpoints/bankid_se.ts:40

waitForAgeVerification

waitForAgeVerification(
id: string,
opts?: PollOptions,
): Promise<AgeVerificationStatus>
Poll until the age verification session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<AgeVerificationStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/bankid_se.ts:133

waitForAuth

waitForAuth(id: string, opts?: PollOptions): Promise<BankIdSeStatus>
Poll until the authentication session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<BankIdSeStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/bankid_se.ts:83

waitForSign

waitForSign(id: string, opts?: PollOptions): Promise<BankIdSeStatus>
Poll until the signing session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<BankIdSeStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/bankid_se.ts:108