IDENTPLUS

IDENTPLUS - Create new identcheck

Create a new identcheck instance.

post 
/api/v1/identchecks.json

Header

Feld Typ Beschreibung
Accept String

application/json
Authorization String

Replace :token with the supplied Auth Token.

Erlaubte Werte: "Bearer :token" 

{
  Accept: "application/json",
  Authorization: "Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

Parameter

Feld Typ Beschreibung
ident_code String

Identification code.
To be passed to the purpose element of the SCT payment order.

Constraints:
* Pattern: /\A(?=.*[0-9])(?=.*[a-z])([a-z0-9]+)\z/
* Min length: 6
* Max length: 15
partner_type String

Type of the partner.

Erlaubte Werte: "LESSOR", "LESSEE", "CARETAKER"

partner_iban String

Valid IBAN of the partner.

Constraints:
* Must start with: "DE"
* Max length: 22
partner_gender String

Gender of the partner.
Codes are: "M" - male, "W" - female, "U" - unknown

Erlaubte Werte: "M", "W", "U"

partner_firstname String

First name of the partner.

Constraints:
* Pattern: /\A[a-zA-ZäÄöÖüÜß]+[a-zA-ZäÄöÖüÜß .-]+\z/
* Min length: 2
* Max length: 44
partner_lastname String

Last name of the partner.

Constraints:
* Pattern: /\A(?=.*[a-zA-ZäÄöÖüÜß]+)[a-zA-ZäÄöÖüÜß .-]+\z/
* Max length: 46

The payment order requires a name for the payee.
This field is assembled from the fields partner_lastname and partner_firstname.

However, the payee's name must match a stricter pattern than it applies to the source fields.
If the validation for the payee's name fails the application tries to adapt certain charaters, e.g. "ü" to "ue".
If the validation still fails a defined fallback name is used instead.
partner_birthdate String

Birth date of the partner.

Required format: "yyyy-mm-dd"
partner_street String

Street name of the partner's address without house number.

Constraints:
* Pattern: /\A[0-9a-zA-ZäÄöÖüÜß .-]+\z/
* Max length for partner_street_and_partner_housenumber
   inclusive a concatenating blank in total: 46
partner_housenumber String

House number of the partner's address.

Constraints:
* Pattern: /\A[0-9a-zA-Z/ .-]+\z/
* Max length for partner_street_and_partner_housenumber
   inclusive a concatenating blank in total: 46
partner_postcode String

Post code of the partner's address.

Constraints:
* Pattern: /\A[0-9]+\z/
* Length: 5
partner_city String

City of the partner's address.

Constraints:
* Pattern: /\A[a-zA-ZäÄöÖüÜß .-]+\z/
* Max length: 44
partner_country String

Country of the partner's address.

Allowed value: "DEU"
contract_type String

Type of the contract.
contract_number String

Number of the contract.
contract_subject String

Subject of the contract.
agb_terms Boolean

AGB terms.

Allowed value: true
dsv_terms Boolean

DSV terms.

Allowed value: true

 
{
    "ident_code": "test123",
    "partner_type": "LESSOR",
    "partner_iban": "DE99123456780123456789",
    "partner_gender": "M",
    "partner_firstname": "Max",
    "partner_lastname": "Mustermann",
    "partner_birthdate": "1950-06-01",
    "partner_street": "Teststr.",
    "partner_housenumber": "10a",
    "partner_postcode": "10000",
    "partner_city": "Test-Stadt",
    "partner_country": "DEU",
    "contract_type": "privat",
    "contract_number": "051823-X1",
    "contract_subject": "Wohnungsmietvertrag",
    "agb_terms": true,
    "dsv_terms": true
}

201 Created

Feld Typ Beschreibung
id String

Identifier of the identcheck instance.
process_status String

Process status information.

Allowed values:

SCT_DISCARDED
SCT_TRIGGERED
SCT_ACCEPTED
SCT_FAILED
process_status_note String

Process status note.

Allowed values:

CHECK_PERSON
CHECK_BANK_CONNECTION
SCHUFA_IBAN_VALIDATION_FAILED
SCHUFA_BIRTHDATE_NOT_VALID_SCOPE
SCHUFA_DATE_NOT_VALID_SCOPE
SCHUFA_POSTCODE_NOT_VALID
SCHUFA_POSTCODE_NOT_ALLOWED
GATEWAY_SCHEMA_VALIDATION_ERROR
GATEWAY_IBAN_CHECKSUM_VALIDATION_FAILED
GATEWAY_IBAN_VALIDATION_FAILED
INVALID_PROCESS

Value can be null.
sct_type String

Type of the SCT payment.

Allowed values:

INSTANT
STANDARD

Value can be null.
created_at String

ISO 8601 timestamp of identcheck record creation.
       ...

Fields having a value of null respective nil are omitted in the response.

 
HTTP/1.1 201 Created
{
  "id": "f19b621c-39f6-4f0b-873e-ec49cb5021ca",
  "process_status": "SCT_TRIGGERED",
  "sct_type": "INSTANT",
  "created_at": "2020-10-01T10:08:22.384Z"
}
HTTP/1.1 201 Created
{
  "id": "c19b621c-39f6-4f0b-873e-ec49cb5021c0",
  "process_status": "SCT_DISCARDED",
  "process_status_note": "CHECK_BANK_CONNECTION",
  "created_at": "2020-10-01T10:07:22.384Z"
}

4xx/5xx Errors

Name Typ Beschreibung
400

Bad Request. Diverse reasons. JSON body could be malformated. No response body.
401

Unauthorized. No response body.
406

Not Acceptable. Diverse reasons. Application interface requires a proper JSON request. No response body.
422

Unprocessable Entity. Diverse reasons. Response body see below.
500

Internal Server Error. No response body.

422 Unprocessable Entity

Name Typ Beschreibung
label Array[Strings]

The label is a field name for field-related error(s) or is called base for not field-related error(s).

 
HTTP/1.1 422 Unprocessable Entity
{
  "ident_code": ["is too short, minimum is 6 characters"],
  "partner_iban": ["is required", "pattern matching failed, must match (?-mix:\\ADE)"],
  "dsv_terms": ["false is not allowed"]
}

IDENTPLUS - Get identcheck status

Get the status of an identcheck instance identified by URL parameter :id.

get 
/api/v1/identchecks/status/:id.json

Header

Feld Typ Beschreibung
Accept String

application/json
Authorization String

Replace :token with the supplied Auth Token.

Erlaubte Werte: "Bearer :token" 

{
  Accept: "application/json",
  Authorization: "Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

200 OK

Feld Typ Beschreibung
id String

Identifier of the identcheck instance.
process_status String

Process status information.

Identcheck status requests are not allowed for process_status "SCT_DISCARDED".
Failing this restriction results in rejection.

Do stop requesting identcheck status as soon as process_status IS NOT "SCT_TRIGGERED".

To be noted:
There is no guarantee that the service provider or financial institutions provide sufficient information in a timely manner, or at all, to be absolutely sure, that the payment has been credited to the payee's account.
This needs to be considered when deriving conclusions on process_status values.

Allowed values:

SCT_TRIGGERED
SCT_ACCEPTED
SCT_FAILED
sct_type String

Type of the SCT payment.

Allowed values:

INSTANT
STANDARD
created_at String

ISO 8601 timestamp of identcheck record creation.
       ...

Fields having a value of null respective nil are omitted in the response.

 
HTTP/1.1 200 OK
{
  "id": "f19b621c-39f6-4f0b-873e-ec49cb5021ca",
  "process_status": "SCT_TRIGGERED",
  "sct_type": "INSTANT",
  "created_at": "2020-10-01T10:30:29.041Z"
}
HTTP/1.1 200 OK
{
  "id": "f19b621c-39f6-4f0b-873e-ec49cb5021ca",
  "process_status": "SCT_ACCEPTED",
  "sct_type": "INSTANT",
  "created_at": "2020-10-01T11:00:29.041Z"
}

4xx/5xx Errors

Name Typ Beschreibung
401

Unauthorized. No response body.
404

Not Found. Response body see below.
406

Not Acceptable. Diverse reasons. Application interface requires a proper JSON request. No response body.
422

Unprocessable Entity. Diverse reasons. Response body see below.
500

Internal Server Error. No response body.

404 Not Found, 422 Unprocessable Entity

Name Typ Beschreibung
label Array[Strings]

The label is a field name for field-related error(s) or is called base for not field-related error(s).

 
HTTP/1.1 404 Not Found
{
  "base": ["record not found"]
}
HTTP/1.1 422 Unprocessable Entity
{
  "base": ["process status not acceptable"]
}
HTTP/1.1 422 Unprocessable Entity
{
  "base": ["record age exceeded"]
}
Erstellt mit apidoc 0.25.0 - 2020-11-05T13:22:02.478Z