Skip to main content

ExternalData

identity object
anyOf
identity objectrequired
document object
anyOf
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
string
given_name object
anyOf
string
birth_date object
anyOf
string
tax object
anyOf
finances objectrequired
income objectrequired
table object[]
  • Array [
  • paying_institution object
    anyOf
    registration_status object
    anyOf
    string
    business_sector_code object
    anyOf
    string
    registration_date object
    anyOf
    string
    legal_business_name object
    anyOf
    string
    site object
    anyOf
    registration_numberRegistration Number (string)required
    legal_form object
    anyOf
    string
    registration_number object
    anyOf
    string
    address object
    anyOf
    formattedFormatted (string)required
    countryCountry (string)
    Default value: FR
    segment object
    anyOf
    string
    net_amount object
    anyOf
    integer
    start_date object
    anyOf
    string
    end_date object
    anyOf
    string
    date object
    anyOf
    string
    type object
    anyOf
    raw object
    anyOf
    string
    normalized object
    anyOf
    string
  • ]
  • worked_months object
    anyOf
    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
    finances objectrequired
    expenses object
    anyOf
    table object[]
  • Array [
  • is_rejected object
    anyOf
    boolean
    type object
    anyOf
    raw object
    anyOf
    string
    normalized object
    anyOf
    string
    net_amount_v2 object
    anyOf
    value object
    anyOf
    number
    currency object
    anyOf
    string
    segment object
    anyOf
    string
    date object
    anyOf
    string
  • ]
  • income object
    anyOf
    table object[]
  • Array [
  • paying_institution object
    anyOf
    registration_status object
    anyOf
    string
    business_sector_code object
    anyOf
    string
    registration_date object
    anyOf
    string
    legal_business_name object
    anyOf
    string
    site object
    anyOf
    registration_numberRegistration Number (string)required
    legal_form object
    anyOf
    string
    registration_number object
    anyOf
    string
    address object
    anyOf
    formattedFormatted (string)required
    countryCountry (string)
    Default value: FR
    segment object
    anyOf
    string
    net_amount object
    anyOf
    integer
    start_date object
    anyOf
    string
    end_date object
    anyOf
    string
    date object
    anyOf
    string
    type object
    anyOf
    raw object
    anyOf
    string
    normalized object
    anyOf
    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
    string
    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"
    }
    }