IDENTPLUS - Create new identcheck
Create a new identcheck instance.
/api/v1/identchecks.json
Header
Feld | Typ | Beschreibung |
---|---|---|
Accept | String |
application/json |
Authorization | String |
Replace Erlaubte Werte:
|
{
Accept: "application/json",
Authorization: "Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
Parameter
Feld | Typ | Beschreibung |
---|---|---|
ident_code | String |
Identification code. Constraints: |
partner_type | String |
Type of the partner. Erlaubte Werte:
|
partner_iban | String |
Valid IBAN of the partner. Constraints: |
partner_gender | String |
Gender of the partner. Erlaubte Werte:
|
partner_firstname | String |
First name of the partner. Constraints: |
partner_lastname | String |
Last name of the partner. Constraints: The payment order requires a name for the payee. However, the payee's name must match a stricter pattern than it applies to the source fields. |
partner_birthdate | String |
Birth date of the partner. Required format: |
partner_street | String |
Street name of the partner's address without house number. Constraints: |
partner_housenumber | String |
House number of the partner's address. Constraints: |
partner_postcode | String |
Post code of the partner's address. Constraints: |
partner_city | String |
City of the partner's address. Constraints: |
partner_country | String |
Country of the partner's address. Allowed value: |
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: |
dsv_terms | Boolean |
DSV terms. Allowed value: |
{
"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 |
sct_type | String |
Type of the SCT payment. Allowed values: INSTANT STANDARD Value can be |
created_at | String |
ISO 8601 timestamp of identcheck record creation. |
... |
Fields having a value of |
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 |
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"]
}