Skip to main content

Applicant

first_name object
anyOf
string
last_name object
anyOf
string
email object
anyOf
string
phone object
anyOf
string
iduuid
statusStatus (string)

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

Default value: NEW
form_submitted object
anyOf
string
score object
anyOf
number
created_atdate-time
updated_at object
anyOf
string
is_guarantorIs Guarantor (boolean)
Default value: false
physical_guarantorsundefined[]
Default value: []
moral_guarantor object
anyOf
file_pathpathrequired
typeType (string)required
created_atdate-timerequired
updated_atdate-timerequired
metaMeta
profile object
anyOf
string
completion_rate object
anyOf
number
is_pre_applicationIs Pre Application (boolean)
Default value: false
pre_application_validated_at object
anyOf
string
documents object[]
  • Array [
    • iduuid
    document_type object
    anyOf
    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
    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
    string
    detected_model object
    anyOf
    string
    alerts object[]
  • Array [
    • codeCode (string)required
    statusStatus (string)required

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

    comment object
    anyOf
    string
    alert_type objectrequired
    idId (string)required
    nameName (string)required
    descriptionDescription (string)required
  • ]
    • files object[]
  • Array [
    • file_iduuidrequired
    file objectrequired
    anyOf
    string

    Possible values: non-empty and <= 2083 characters

    thumbnail objectrequired
    anyOf
    string

    Possible values: non-empty and <= 2083 characters

    images objectrequired
    anyOf
  • Array [
    • uri

    Possible values: non-empty and <= 2083 characters

  • ]
    • pagesinteger[]
    Default value: []
  • ]
  • ]
    • financial_resume object
    anyOf
    payslip_incomes object
    anyOf
    number
    taxnotice_incomes object
    anyOf
    number
    wages object
    anyOf
  • Array [
    • periodPeriod (string)required
    amountAmount (number)required
  • ]
    • estimated_incomes object
    anyOf
    number
    estimated_solvency object
    anyOf
    number
    form_availableForm Available (boolean)

    If applicant has a form associated

    Default value: false
    Applicant
    {
      "first_name": "string",
      "last_name": "string",
      "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",
          "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,
        "wages": [
          {
            "period": "string",
            "amount": 0
          }
        ],
        "estimated_incomes": 0,
        "estimated_solvency": 0
      },
      "form_available": false
    }