Applicant

first_name object

anyOf

MOD1
MOD2

string

last_name object

anyOf

MOD1
MOD2

string

birth_date object

anyOf

MOD1
MOD2

string

email object

anyOf

MOD1
MOD2

string

phone object

anyOf

MOD1
MOD2

string

iduuid

statusStatus (string)

Possible values: [NEW, OPEN, COLLECT_STARTED, COLLECT_COMPLETE, COLLECTED, ANALYZED, CLOSED]

Default value: NEW

form_submitted object

anyOf

MOD1
MOD2

string

score object

anyOf

MOD1
MOD2

number

created_atdate-time

updated_at object

anyOf

MOD1
MOD2

string

is_guarantorIs Guarantor (boolean)

Default value: false

physical_guarantorsundefined[]

Default value: []

moral_guarantor object

anyOf

MoralGuarantor
MOD2

file_pathpathrequired

typeType (string)required

created_atdate-timerequired

updated_atdate-timerequired

metaMeta

profile object

anyOf

MOD1
MOD2

string

completion_rate object

anyOf

MOD1
MOD2

number

is_pre_applicationIs Pre Application (boolean)

Default value: false

pre_application_validated_at object

anyOf

MOD1
MOD2

string

documents object[]

Array [

iduuid

document_type object

anyOf

ListAcceptedDocument
MOD2
MOD3

nameName (string)required

max_pagesMax Pages (integer)

Default value: 1

analyzed_asAnalyzed As (string)

Possible values: [ID, PAY_SLIP, TAX_NOTICE, STUDENT_CARD, NOT_ANALYZED]

Default value: NOT_ANALYZED

examplesstring[]

Default value: []

to_download object

anyOf

MOD1
MOD2
MOD3

string

iduuid

tenantTenant (string)required

statusStatus (string)

Possible values: [RECEIVED, PROCESSING, PROCESSED, EXTRACTING, EXTRACTED, VALIDATING, VALIDATED, COLLECTED, ACTION_REQUIRED, APPLICANT_ACTION_REQUIRED, REJECTED]

Default value: RECEIVED

created_atdate-time

updated_at object

anyOf

MOD1
MOD2

string

model_versionModel Version (integer)

Default value: 1

detected_model object

anyOf

MOD1
MOD2

string

alerts object[]

Array [

codeCode (string)required

statusStatus (string)required

Possible values: [SUCCESS, WARNING, ERROR, NEUTRAL]

comment object

anyOf

MOD1
MOD2

string

alert_type objectrequired

idId (string)required

nameName (string)required

descriptionDescription (string)required

]

files object[]

Array [

file_iduuidrequired

file objectrequired

anyOf

MOD1
MOD2

string

Possible values: non-empty and <= 2083 characters

thumbnail objectrequired

anyOf

MOD1
MOD2

string

Possible values: non-empty and <= 2083 characters

images objectrequired

anyOf

MOD1
MOD2

Array [

uri

Possible values: non-empty and <= 2083 characters

]

pagesinteger[]

Default value: []

]

financial_resume object

payslip_incomes object

anyOf

MOD1
MOD2

number

taxnotice_incomes object

anyOf

MOD1
MOD2

number

taxable_incomes object

anyOf

TaxableIncome
MOD2

type object

anyOf

MOD1
MOD2

string

amount object

anyOf

MOD1
MOD2

number

period_lengthPeriod Length (integer)

Default value: 12

editedEdited (boolean)

indicates if user has changed it or if auto generated

Default value: false

wages object

anyOf

MOD1
MOD2

Array [

document_id object

anyOf

MOD1
MOD2

string

periodPeriod (string)

Default value:

period_start object

anyOf

MOD1
MOD2

string

period_end object

anyOf

MOD1
MOD2

string

amount object

anyOf

MOD1
MOD2

number

ajusted_amount object

anyOf

MOD1
MOD2

number

selectedSelected (boolean)

Default value: true

editedEdited (boolean)

indicates if user has changed it or if auto generated

Default value: false

]

additional_incomes object[]

Array [

type object

anyOf

MOD1
MOD2

string

comment object

anyOf

MOD1
MOD2

string

amount object

anyOf

MOD1
MOD2

number

period_lengthPeriod Length (integer)

Default value: 1

period_start object

anyOf

MOD1
MOD2

string

period_end object

anyOf

MOD1
MOD2

string

srcSrc (string)

Possible values: [manual, auto]

Default value: auto

]

estimated_incomes object

anyOf

MOD1
MOD2

number

estimated_solvency object

anyOf

MOD1
MOD2

number

form_availableForm Available (boolean)

If applicant has a form associated

Default value: false

external_data object

identity object

anyOf

IdentityUserInfo
MOD2

identity objectrequired

document object

anyOf

IdentityDocument
MOD2

type objectrequired

normalizedNormalized (string)required

Possible values: [identity_card, passport, driving_license, residence_permit]

rawRaw (string)required

nationalityNationality (string)required

given_nameGiven Name (string)required

family_nameFamily Name (string)required

genderGender (string)required

nameName (string)required

birthdatedaterequired

family_name object

anyOf

MOD1
MOD2

string

given_name object

anyOf

MOD1
MOD2

string

birth_date object

anyOf

MOD1
MOD2

string

tax object

anyOf

TaxUserInfo
MOD2

finances objectrequired

income objectrequired

table object[]

Array [

paying_institution object

anyOf

PayingInstitution
MOD2

registration_status object

anyOf

MOD1
MOD2

string

business_sector_code object

anyOf

MOD1
MOD2

string

registration_date object

anyOf

MOD1
MOD2

string

legal_business_name object

anyOf

MOD1
MOD2

string

site object

anyOf

PayingInstitutionSite
MOD2

registration_numberRegistration Number (string)required

legal_form object

anyOf

MOD1
MOD2

string

registration_number object

anyOf

MOD1
MOD2

string

address object

anyOf

Address
MOD2

formattedFormatted (string)required

countryCountry (string)

Default value: FR

segment object

anyOf

MOD1
MOD2

string

net_amount object

anyOf

MOD1
MOD2
MOD3

integer

start_date object

anyOf

MOD1
MOD2

string

end_date object

anyOf

MOD1
MOD2

string

date object

anyOf

MOD1
MOD2

string

type object

anyOf

IncomeType
MOD2

raw object

anyOf

MOD1
MOD2

string

normalized object

anyOf

MOD1
MOD2

string

]

worked_months object

anyOf

MOD1
MOD2

integer

tax objectrequired

income objectrequired

tax_notice objectrequired

declarersDeclarersrequired

property_income_net_amountProperty Income Net Amount

postal_address objectrequired

formattedFormatted (string)required

countryCountry (string)

Default value: FR

nameName (string)required

given_nameGiven Name (string)required

family_nameFamily Name (string)required

address objectrequired

countryCountry (string)required

formattedFormatted (string)required

birthdatedaterequired

studentStudent

open_banking object

anyOf

OpenBankingUserInfo
MOD2

finances objectrequired

expenses object

anyOf

FinanceExpense
MOD2

table object[]

Array [

is_rejected object

anyOf

MOD1
MOD2

boolean

type object

anyOf

ExpenseType
MOD2

raw object

anyOf

MOD1
MOD2

string

normalized object

anyOf

MOD1
MOD2

string

net_amount_v2 object

anyOf

AmountV2
MOD2

value object

anyOf

MOD1
MOD2
MOD3

number

currency object

anyOf

MOD1
MOD2

string

segment object

anyOf

MOD1
MOD2

string

date object

anyOf

MOD1
MOD2

string

]

income object

anyOf

FinanceIncome
MOD2

table object[]

Array [

paying_institution object

anyOf

PayingInstitution
MOD2

registration_status object

anyOf

MOD1
MOD2

string

business_sector_code object

anyOf

MOD1
MOD2

string

registration_date object

anyOf

MOD1
MOD2

string

legal_business_name object

anyOf

MOD1
MOD2

string

site object

anyOf

PayingInstitutionSite
MOD2

registration_numberRegistration Number (string)required

legal_form object

anyOf

MOD1
MOD2

string

registration_number object

anyOf

MOD1
MOD2

string

address object

anyOf

Address
MOD2

formattedFormatted (string)required

countryCountry (string)

Default value: FR

segment object

anyOf

MOD1
MOD2

string

net_amount object

anyOf

MOD1
MOD2
MOD3

integer

start_date object

anyOf

MOD1
MOD2

string

end_date object

anyOf

MOD1
MOD2

string

date object

anyOf

MOD1
MOD2

string

type object

anyOf

IncomeType
MOD2

raw object

anyOf

MOD1
MOD2

string

normalized object

anyOf

MOD1
MOD2

string

]

credit_scoring objectrequired

scoreScore (integer)required

financials objectrequired

accounts object[]required

Array [

ibanIban (string)required

account_holder objectrequired

nameName (string)required

]

nameName (string)required

birthdate object

anyOf

MOD1
MOD2

string

otherOther

Applicant
{
  "first_name": "string",
  "last_name": "string",
  "birth_date": "2024-07-29",
  "email": "user@example.com",
  "phone": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "NEW",
  "form_submitted": "2024-07-29T15:51:28.071Z",
  "score": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "is_guarantor": false,
  "physical_guarantors": [
    null
  ],
  "moral_guarantor": {
    "file_path": "string",
    "type": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  },
  "profile": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "completion_rate": 0,
  "is_pre_application": false,
  "pre_application_validated_at": "2024-07-29T15:51:28.071Z",
  "documents": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "document_type": {
        "name": "string",
        "max_pages": 1,
        "analyzed_as": "NOT_ANALYZED",
        "examples": [
          "string"
        ],
        "to_download": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenant": "string"
      },
      "status": "RECEIVED",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "model_version": 1,
      "detected_model": "string",
      "alerts": [
        {
          "code": "string",
          "status": "SUCCESS",
          "comment": "string",
          "alert_type": {
            "id": "string",
            "name": "string",
            "description": "string"
          }
        }
      ],
      "files": [
        {
          "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "file": "string",
          "thumbnail": "string",
          "images": [
            "string"
          ],
          "pages": [
            0
          ]
        }
      ]
    }
  ],
  "financial_resume": {
    "payslip_incomes": 0,
    "taxnotice_incomes": 0,
    "taxable_incomes": {
      "type": "string",
      "amount": 0,
      "period_length": 12,
      "edited": false
    },
    "wages": [
      {
        "document_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "period": "string",
        "period_start": "2024-07-29",
        "period_end": "2024-07-29",
        "amount": 0,
        "ajusted_amount": 0,
        "selected": true,
        "edited": false
      }
    ],
    "additional_incomes": [
      {
        "type": "string",
        "comment": "string",
        "amount": 0,
        "period_length": 1,
        "period_start": "2024-07-29",
        "period_end": "2024-07-29",
        "src": "auto"
      }
    ],
    "estimated_incomes": 0,
    "estimated_solvency": 0
  },
  "form_available": false,
  "external_data": {
    "identity": {
      "identity": {
        "document": {
          "type": {
            "normalized": "identity_card",
            "raw": "string"
          }
        },
        "nationality": "string",
        "given_name": "string",
        "family_name": "string",
        "gender": "string",
        "name": "string",
        "birthdate": "2024-07-29"
      },
      "family_name": "string",
      "given_name": "string",
      "birth_date": "2024-07-29"
    },
    "tax": {
      "finances": {
        "income": {
          "table": [
            {
              "paying_institution": {
                "registration_status": "string",
                "business_sector_code": "string",
                "registration_date": "2024-07-29",
                "legal_business_name": "string",
                "site": {
                  "registration_number": "string"
                },
                "legal_form": "string",
                "registration_number": "string",
                "address": {
                  "formatted": "string",
                  "country": "FR"
                }
              },
              "segment": "string",
              "net_amount": 0,
              "start_date": "2024-07-29",
              "end_date": "2024-07-29",
              "date": "2024-07-29",
              "type": {
                "raw": "string",
                "normalized": "string"
              }
            }
          ],
          "worked_months": 0
        }
      },
      "tax": {
        "income": {
          "tax_notice": {
            "postal_address": {
              "formatted": "string",
              "country": "FR"
            }
          }
        }
      },
      "name": "string",
      "given_name": "string",
      "family_name": "string",
      "address": {
        "country": "string",
        "formatted": "string"
      },
      "birthdate": "2024-07-29"
    },
    "open_banking": {
      "finances": {
        "expenses": {
          "table": [
            {
              "is_rejected": true,
              "type": {
                "raw": "string",
                "normalized": "string"
              },
              "net_amount_v2": {
                "value": 0,
                "currency": "string"
              },
              "segment": "string",
              "date": "2024-07-29"
            }
          ]
        },
        "income": {
          "table": [
            {
              "paying_institution": {
                "registration_status": "string",
                "business_sector_code": "string",
                "registration_date": "2024-07-29",
                "legal_business_name": "string",
                "site": {
                  "registration_number": "string"
                },
                "legal_form": "string",
                "registration_number": "string",
                "address": {
                  "formatted": "string",
                  "country": "FR"
                }
              },
              "segment": "string",
              "net_amount": 0,
              "start_date": "2024-07-29",
              "end_date": "2024-07-29",
              "date": "2024-07-29",
              "type": {
                "raw": "string",
                "normalized": "string"
              }
            }
          ]
        },
        "credit_scoring": {
          "score": 0
        }
      },
      "financials": {
        "accounts": [
          {
            "iban": "string",
            "account_holder": {
              "name": "string"
            }
          }
        ]
      },
      "name": "string",
      "birthdate": "2024-07-29"
    }
  }
}