Sign in
latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Person identifications

Set identification to failed

This endpoint sets the status of an identification to failed. Use this endpoint if the identification is still is in pending status and you want to fail it with a reason.

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

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

Request body

reasonstring required

The reason of failing the identification.

Example request

{
  "reason": "Customer abandoned the SDK flow"
}

Response

Successful result of the operation

idstring

ID of the person identification.

referencestring

Reference generated by the identification provider.

urlstring

(IDnow only) Redirect URL used to start the identification process.

status'aborted' | 'authorization_required' | 'confirmation_required' | 'confirmed' | 'created' | 'canceled' | 'expired' | 'failed' | 'identification_data_required' | 'pending' | 'pending_account_creation' | 'pending_successful' | 'pending_failed' | 'pending_ref_transfer' | 'pre_successful' | '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 was completed.

method'bank' | 'bank_id' | 'bank_plus' | 'fourthline' | 'idnow' | 'idnow_autoident' | 'idnow_custom' | 'manual' | 'postident'

The method used for the identification.

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

The type of document submitted by the customer as a proof of address if their identification document did not include their address.

proof_of_address_issued_atstring

The date when the proof of address document was issued.

language'DE' | 'EN'

(IDnow only) The customer's preferred language for the identification process.

person_idstring

ID of the person for whom the identification was initiated.

failure_reasonstring nullable

Additional context around why the identification failed. Value depends on the identification method.

ibanstring

Optional IBAN provided for bank and bank_id identifications. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

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.

provider_status_code1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008 | 1009 | 1010 | 1011 | 1012 | 1013 | 1014 | 1015 | 1016 | 1017 | 1018 | 1019 | 1020 | 1021 | 1022 | 1023 | 1024 | 1030 | 1031 | 1032 | 1033 | 1034 | 1035 | 1036 | 1037 | 1038 | 1100 | 2001 | 2002 | 2003 | 3001 | 3002 | 3003 | 3004 | 3005 | 3100 | 3101 | 3102 | 3103 | 3104 | 3105 | 3106 | 3107 | 3200 | 3201 | 3202 | 3203 | 3204 | 3205 | 3206 | 3207 | 3208 | 3209 | 3210 | 3211 | 3250 | 3300 | 3304 | 3305 | 3306 | 3307 | 3308 | 3400 | 3401 | 3402 | 3403 | 3404 | 3405 | 3406 | 3407 | 3408 | 3500 | 3510 | 3520 | 3540 | 3600 | 3601 | 3602 | 3603 | 3610 | 3620 nullable

(Fourthline only) Status code returned by the identification provider.

account_verification_error'accounts_failed' | 'client_aborted' | 'init_failed' | 'login_failed' | 'login_next_failed' | 'max_login_tries' | 'max_tan_tries' | 'no_compatible_accounts' | 'pinned_iban_not_found' | 'security_setting_rejection' | 'session_expired' | 'tech_error' | 'transaction_failed' | 'turnovers_failed' | 'validation_failed' nullable

Session Error returned by Tink in the account verification process. Will only be populated when failure_reason is account_snaphot_failed or account_snapshot_expired. Only present for identifications within identification session.

idnow_process_typestring

When method idnow is selected, the process type will reflect which idnow process was chosen.

Example response

{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/company_id/identifications/identification_id",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "language": "EN",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "address": {
    "line_1": "BERLINER STR. 45",
    "line_2": "Erste Etage",
    "postal_code": "14169",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "documents": [
    {
      "id": "448b75fa1c57eecda41d91c66c22faa6cdoc",
      "name": "file1.pdf",
      "content_type": "application/json",
      "document_type": "KYC_REPORT",
      "size": 803580
    },
    {
      "id": "94eb22a9311be9a1fbb698c448b0b337cdoc",
      "name": "file2.jpg",
      "content_type": "image/jpeg",
      "document_type": "SIGNATURE",
      "size": 25349
    }
  ],
  "iban": "DE11010101010101010100",
  "idnow_process_type": "eid"
}