ExternalData

identity object

anyOf

IdentityUserInfo

identity objectrequired

document object

anyOf

IdentityDocument

type objectrequired

normalizedNormalized (string)required

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

rawRaw (string)required

MOD2

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

string

MOD2

given_name object

anyOf

MOD1

string

MOD2

birth_date object

anyOf

MOD1

string

MOD2

MOD2

tax object

anyOf

TaxUserInfo

finances objectrequired

income objectrequired

table object[]

Array [

paying_institution object

anyOf

PayingInstitution

registration_status object

anyOf

MOD1

string

MOD2

business_sector_code object

anyOf

MOD1

string

MOD2

registration_date object

anyOf

MOD1

string

MOD2

legal_business_name object

anyOf

MOD1

string

MOD2

site object

anyOf

PayingInstitutionSite

registration_numberRegistration Number (string)required

MOD2

legal_form object

anyOf

MOD1

string

MOD2

registration_number object

anyOf

MOD1

string

MOD2

address object

anyOf

Address

formattedFormatted (string)required

countryCountry (string)

Default value: FR

MOD2

MOD2

segment object

anyOf

MOD1

string

MOD2

net_amount object

anyOf

MOD1

integer

MOD2

number

MOD3

start_date object

anyOf

MOD1

string

MOD2

end_date object

anyOf

MOD1

string

MOD2

date object

anyOf

MOD1

string

MOD2

type object

anyOf

IncomeType

raw object

anyOf

MOD1

string

MOD2

normalized object

anyOf

MOD1

string

MOD2

MOD2

]

worked_months object

anyOf

MOD1

integer

MOD2

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

MOD2

studentStudent

open_banking object

anyOf

OpenBankingUserInfo

finances objectrequired

expenses object

anyOf

FinanceExpense

table object[]

Array [

is_rejected object

anyOf

MOD1

boolean

MOD2

type object

anyOf

ExpenseType

raw object

anyOf

MOD1

string

MOD2

normalized object

anyOf

MOD1

string

MOD2

MOD2

net_amount_v2 object

anyOf

AmountV2

value object

anyOf

MOD1

number

MOD2

integer

MOD3

currency object

anyOf

MOD1

string

MOD2

MOD2

segment object

anyOf

MOD1

string

MOD2

date object

anyOf

MOD1

string

MOD2

]

MOD2

income object

anyOf

FinanceIncome

table object[]

Array [

paying_institution object

anyOf

PayingInstitution

registration_status object

anyOf

MOD1

string

MOD2

business_sector_code object

anyOf

MOD1

string

MOD2

registration_date object

anyOf

MOD1

string

MOD2

legal_business_name object

anyOf

MOD1

string

MOD2

site object

anyOf

PayingInstitutionSite

registration_numberRegistration Number (string)required

MOD2

legal_form object

anyOf

MOD1

string

MOD2

registration_number object

anyOf

MOD1

string

MOD2

address object

anyOf

Address

formattedFormatted (string)required

countryCountry (string)

Default value: FR

MOD2

MOD2

segment object

anyOf

MOD1

string

MOD2

net_amount object

anyOf

MOD1

integer

MOD2

number

MOD3

start_date object

anyOf

MOD1

string

MOD2

end_date object

anyOf

MOD1

string

MOD2

date object

anyOf

MOD1

string

MOD2

type object

anyOf

IncomeType

raw object

anyOf

MOD1

string

MOD2

normalized object

anyOf

MOD1

string

MOD2

MOD2

]

MOD2

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

string

MOD2

MOD2

otherOther

ExternalData

{
  "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"
  }
}