Sign in
latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Person identifications

Start e-signing authorization process

This method begins the authorization process for a person identification via BankIdent. When called, it triggers a Swisscom iframe and it also prompts Swisscom to send an SMS OTP to the customer. Call this endpoint when an identification reaches the authorization_required status.

patch/v1/persons/{person_id}/identifications/{id}/authorize

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper
idstring required

The unique ID of the identification resource created for a customer.

Example:6dc54352d6793a892e0702850d07b831cidt

Response

The QES process has been triggered. The customer must confirm by entering the received SMS OTP.

idstring

The unique ID of the identification resource.

referencestring

A reference supplied by the identification provider.

urlstring

The URL returned from FinTechSystem to which you must redirect the customer for the bank account login and payment authorization.

status'aborted' | 'authorization_required' | 'confirmation_required' | 'confirmed' | 'created' | 'canceled' | 'expired' | 'failed' | 'identification_data_required' | 'pending' | 'pending_successful' | 'pending_failed' | 'processed' | 'rejected' | 'successful' | 'signed'

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

completed_atstring

Date and time when the identification process was completed.

method'bank' | 'bank_id' | 'fourthline' | 'idnow' | 'manual' | 'postident'

The identification method to use for the person identification.

proof_of_address_type'BANK_ACCOUNT_STATEMENT' | 'CERTIFICATE_OF_REGISTRATION' | 'ELECTRICITY_BILL' | 'GAS_BILL' | 'HEATING_BILL' | 'INTERNET_BILL' | 'TELEPHONE_BILL' | 'WATER_BILL' nullable

The type of document submitted by the customer as a proof of address. This field is mandatory if the customer's identification document does not include their address.

proof_of_address_issued_atstring date nullable

The date when the proof of address document was issued. This field is mandatory if the customer's identification document does not include their address.

ibanstring

The customer's IBAN. This field is mandatory if the identification method is bank or bank_id.

terms_and_conditions_signed_atstring nullable

The date and time from when the customer signed Swisscom's terms and conditions.

authorization_expires_atstring nullable

The date and time by which the authorization for the end customer must be requested.

confirmation_expires_atstring nullable

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

current_reference_tokenstring
estimated_waiting_timestring

(IDnow only) Estimated waiting time until an agent is available.

Example response

{
  "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
  "reference": "null",
  "url": "https://fts-payment-initiation-wizard.solaris-sandbox.de/index.html?wizard_session_key=bfo5r16AMLlt6ZEX9Oh3JUWIkTelorupBwzIlJRR&interface_id=da05",
  "status": "confirmation_required",
  "completed_at": "null",
  "method": "bank",
  "iban": "DE11110101010100000020",
  "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
  "authorization_expires_at": "2022-08-11T08:38:21.000Z",
  "confirmation_expires_at": "2022-08-11T08:37:23.000Z",
  "current_reference_token": "1234-5678",
  "estimated_waiting_time": "null"
}