getGet a person

❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.

Learn about authentication →

Use this endpoint to fetch information about a customer. If the data in question requires prior consent from the customer, then you need to create an inquiry first and give the inquiry url to your customer, so that they can consent to share their data.


When the inquiry is completed by the customer, you can come back and use the inquiryId to fetch data.

curl --request GET \
  --url 'https://api.test.neobits.no/fuse/v2/persons/01029413157?inquiryId=0679c533-5061-496e-8dc5-df786f04a209' \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH'

Request

Headers

  • Authorization•string

    Basic authentication, base64 encoded username:password.

Params (path)

  • ssn•string

    The unique identifier for the person

Params (query)

  • inquiryId•string<uuid>

    If the data you are fetching requires an inquiry to be created and completed by the customer first, then this parameter is required.

Response

Headers

  • Content-Type•string

    The content type of the response.

  • X-Request-ID•string<uuid>

    UUID generated on each request. Provide this id to customer support if an error occurs.

Body

  • ssn•string

  • firstName•string

  • lastName•string

  • maritalStatus•string

  • citizenships•array<object>

    • citizenship•string

    • isApplicable•boolean

      maps to 'erGjeldende' in the original response

  • gender•string

  • birthdate•string<date>

  • countryOfBirth•string

  • status•string

    The current status of the person in the Norwegian Population Registry

  • employmentStatus•string

    Inferred from the applicants income report of the last month.

  • receivesSocialSecurityBenefits•boolean

    Inferred from the applicants income report of the last month.

  • hasAttachmentCharge•boolean

    Searches through the movables registry (løsøre) to find active attachment charges (UTLEGG/UTPANTING).

  • residentialAddress•object

    The persons Norwegian residential address. May be null, if the person is living in a foreign country.

  • family•object

    • numChildrenBelowAge18•integer

      Number of persons in the family that are below 18 years of age

    • members•array<object>

      • ssn•string

        11 digit identification number of the person.

      • age•integer

      • gender•string

      • relation•string

        The persons relation to the family member.

  • property•object

    Aggregation of Kartverket API and Eiendomsverdi API

    • ownsProperty•boolean

    • properties•array<object>

      • id•string

      • type•string

      • value•number<double>

      • valueEstimate•number<double>

      • valueEstimateHaircut•number<double>

      • commonDebt•number<double>

      • netValueEstimate•number<double>

      • grossValueEstimate•number<double>

      • areaMarketScore•integer

      • municipalityScore•integer

      • customerApprovedValue•integer

      • valueEstimateAccuracyLevel•number<double>

      • purchasedAt•string<date-time>

      • cadastralUnitNumber•string

      • propertyUnitNumber•string

      • leaseholdNumber•string

      • condominiumUnitNumber•string

      • ownershipShare•number

      • estateType•string

      • street•object

        • name•string

        • number•string

        • letter•string

      • zip•object

        • code•string

        • area•string

      • municipality•object

        • number•string

        • area•string

      • liens•array<object>

        • id•string

        • updatedAt•string<date-time>

        • creditorName•string

        • creditorOrgNumber•string

        • value•number

  • debt•object

    • sumEstimatedBalance•number<double>

    • sumOriginalBalance•number<double>

    • sumAccruedInterestFromDebtCollectors•number<double>

    • sumOwedMaintenancePayments•number<double>

    • sumOwedUnderpaidTax•number<double>

    • sumLatePaymentInterest•number<double>

    • mortgageDebt•object

      • sumEstimatedBalance•number<double>

      • sumOriginalBalance•number<double>

      • sumEstimatedBalanceByOwnership•number<double>

      • sumOriginalBalanceByOwnership•number<double>

      • debts•array<object>

        • creditorName•string

        • estimatedBalance•number<double>

          An estimate of what the balance might be today.

        • originalBalance•number<double>

          The balance gathered from the data source.

        • updatedAt•string

          Updated date in the source registry.

        • createdAt•string

          Created date in the source registry.

        • estimatedDuration•number

          Specifies the estimated duration in months used in the amortization calculations

        • estimatedRemainingDuration•number

          Specifies the estimated remaining duration in months of the loan

        • estimatedNominalInterestRate•number<double>

          Specifies the estimated nominal interest rate used in the amortization calculations

        • estimatedMonthlyPayment•number<double>

          Specifies the estimated monthly downpayment as a result of the amortization calculations

        • propertyOwnershipShare•number<double>

          The ownership share of the property in the mortgage.

        • originalBalanceByOwnership•number<double>

          The original balance multiplied by the property ownership share.

        • estimatedBalanceByOwnership•number<double>

          The estimated balance multiplied by the property ownership share.

        • adjustedOriginalBalance•number<double>

          The assumed actual original balance of the mortgage.

        • balanceSource•string

          Specifies which source the originalBalance and estimatedBalance come from.

        • lienId•string

        • propertyId•string

    • studentDebt•object

      • sumEstimatedBalance•number<double>

      • sumOriginalBalance•number<double>

      • debts•array<object>

        • creditorName•string

        • estimatedBalance•number<double>

          An estimate of what the balance might be today.

        • originalBalance•number<double>

          The balance gathered from the data source.

        • updatedAt•string

          Updated date in the source registry.

        • createdAt•string

          Created date in the source registry.

        • estimatedDuration•number

          Specifies the estimated duration in months used in the amortization calculations

        • estimatedRemainingDuration•number

          Specifies the estimated remaining duration in months of the loan

        • estimatedNominalInterestRate•number<double>

          Specifies the estimated nominal interest rate used in the amortization calculations

        • estimatedMonthlyPayment•number<double>

          Specifies the estimated monthly downpayment as a result of the amortization calculations

        • balanceSource•string

          Specifies which source the originalBalance and estimatedBalance come from.

    • autoDebt•object

      • sumEstimatedBalance•number<double>

      • sumOriginalBalance•number<double>

      • debts•array<object>

        • creditorName•string

        • estimatedBalance•number<double>

          An estimate of what the balance might be today.

        • originalBalance•number<double>

          The balance gathered from the data source.

        • updatedAt•string

          Updated date in the source registry.

        • createdAt•string

          Created date in the source registry.

        • estimatedDuration•number

          Specifies the estimated duration in months used in the amortization calculations

        • estimatedRemainingDuration•number

          Specifies the estimated remaining duration in months of the loan

        • estimatedNominalInterestRate•number<double>

          Specifies the estimated nominal interest rate used in the amortization calculations

        • estimatedMonthlyPayment•number<double>

          Specifies the estimated monthly downpayment as a result of the amortization calculations

        • registrationNumber•string

          The registration number of the vehicle.

        • balanceSource•string

          Specifies which source the originalBalance and estimatedBalance come from.

    • unsecuredDebt•object

      • sumBalance•number<double>

      • sumOriginalBalance•number<double>

      • sumCreditLimit•number<double>

      • debts•array<object>

        • type•string

        • createdAt•string

          Created date in the source registry.

        • updatedAt•string

          Created date in the source registry.

        • creditorOrgNumber•string

          Organization number of the creditor

        • creditorName•string

          Name of the creditor

        • coBorrower•string

          Specifies the coborrower status. HAS_CO_BORROWER means the loan has a co-borrower, NO_CO_BORROWER means there are no co-borrowers, IS_CO_BORROWER means the applicant is a co-borrower of this loan.

        • balance•number

          Outstanding balance of the loan.

        • originalBalance•number

          Applies only to type REPAYMENT_LOAN

        • creditLimit•number

          Applies only to type CREDIT_FACILITY

        • installmentCharges•number

        • installmentChargePeriod•string

        • interestBearingBalance•number

        • nonInterestBearingBalance•number

        • nomInterestRate•number<double>

        • paymentsPerYear•number

        • duration•number

          Applies only to type REPAYMENT_LOAN

  • income•object

    • yearlyGrossIncome•number<double>

    • yearlyNetIncome•number<double>

    • yearlyDrivingAllowance•number<double>

    • yearlyBonus•number<double>

    • yearlySalary•number<double>

    • yearlyWage•number<double>

    • yearlySicknessAllowance•number<double>

    • yearlyDisabilityPension•number<double>

    • yearlyPension•number<double>

    • yearlyUnemploymentBenefit•number<double>

    • yearlyWorkAssessmentAllowance•number<double>

    • monthlyIncomeRecords•array<object>

      • grossIncome•number<double>

      • netIncome•number<double>

      • date•string<YYYY-MM>

    • taxRecords•array<object>

      Sorted by key "taxYear" in descending order

      • taxYear•string

      • yearlyGrossIncome•number<double>

      • yearlySalary•number<double>

      • yearlyRentalIncome•number<double>

      • yearlyEstimatedTax•number<double>

      • yearlyEstimatedNetIncome•number<double>

      • employers•array<object>

        • name•string

        • orgID•string