Benefit (INSS)

The Benefit entity is recovered from INSS institution. It represents a benefit received through INSS. So far, the only product (benefit) supported is retirement.

{
  "id": "05c693bf-c196-47ea-a28c-8251d6bb8a06",
  "itemId": "5e9f8f8f-f8f8-4f8f-8f8f-8f8f8f8f8f8f",
  "number": "000000721792794",
  "type": "BENEFIT",
  "beneficiaryName": "John Doe",
  "marginBaseValue": 1000,
  "availableMarginValue": 1000,
  "usedMarginValue": 0,
  "reservedMarginValue": 0,
  "deductibleAvailableMarginValue": 1000,
  "payingInstitution": {
    "name": "Bank",
    "code": "001",
    "agency": "1234",
    "account": "123456"
  },
  "loans": [
    {
      "contractCode": "123456",
      "nominalInterestRate": 3,
      "efectiveInterestRate": 10,
      "cetAnnualRate": 12,
      "cetMonthRate": 2,
      "currencyCode": "BRL",
      "amortizationRegime": "PRICE",
      "operationHiringDate": "2021-01-01",
      "installmentsQuantity": 12,
      "installmentsValue": 1000,
      "dueDateFirstInstallment": "2021-02-01",
      "dueDateLastInstallment": "2022-01-01",
      "cnpjCorrespondentBanking": "12345678901234",
      "pdfContract": "cGRmIGV4YW1wbGU=",
      "client": {
        "document": "12345678901",
        "name": "John Doe",
        "phone": "11999999999",
        "addressStreet": "Main Street",
        "addressNumber": "123",
        "addressCity": "Sao Paulo",
        "addressZipCode": "12345678",
        "addressState": "SP"
      }
    }
  ]
}
PropertyTypeOptionalDescription
idstringNoUnique identifier of the Loan model
itemIdstringNoId of the item related to this loan
numberstringNoNumber of the benefit
typestringNoBenefit type supported
beneficiaryNamestringNoBenefit Name
marginBaseValuenumberYesTotal benefit value
availableMarginValuenumberYesValue available for new loan request.
usedMarginValuenumberYesValue already used in a loan (consignated credit)
reservedMarginValuenumberYesValue from the total available reserved not to be used.
deductibleAvailableMarginValuenumberYesTotal value available for getting credit.
This value is 35% of the total benefit value
(marginBaseValue)
payingInstitutionobjectYesPayingInstitutionType
loansarrayYesBenefitLoanType

Paying Institution

PropertyTypeOptionalDescription
namestringYesIntitution's name in which which benefit is received
codestringYesCompe institution code
agencystringYesBank agency number
accountstringYesBank account nunber

Benefit Loan

PropertyTypeOptionalDescription
contractCodestringNoUnique identifier for the contract
cnpjOriginalContractCreditorstringYesCNPJ (Brazilian company ID) of the original contract creditor
effectiveInterestRatenumberYesEffective interest rate of the contract
cetAnnualRatenumberYesTotal Effective Cost (CET) annual rate
cetMonthRatenumberYesTotal Effective Cost (CET) month rate
currencyCodestringNoCurrency code in which the contract is denominated
amortizationRegimestringYesAmortization regime of the loan
operationHiringDatestringNoDate when the contract was signed
installmentsQuantitynumberNoTotal number of installments for the loan
installmentsValuenumberNoValue of each installment
dueDateFirstInstallmentstringYesDue date of the first installment
dueDateLastInstallmentstringYesDue date of the last installment
cnpjCorrespondentBankingstringYesCNPJ of the corresponding banking institution
pdfContractstringYesPDF Contract in base 64
clientobjectNoClientType

Client

PropertyTypeOptionalDescription
documentstringNoFree field to complement the information regarding the Type of reference rate or indexer
namestringNoClient name in contract
phonestringYesClient phone in contract
addressStreetstringYesAddress street name in contract
addressNumberstringYesAddress number in contract
addressCitystringYesAddress city in contract
addressZipCodestringYesAddress zip code in contract
addressStatestringYesAddress state in contract

Benefit types supported

These are the benefit types that we support and are the ones that could have payroll loans (Loans that are payed directly from the benefit)

Description
Aposentadoria por idade do trabalhador rural
Aposentadoria por idade do empregador rural
Aposentadoria por idade
Aposentadoria por idade (Extinto Plano Básico)
Aposentadoria por idade de ex-combatente marítimo (Lei nº 1.756/52)
Aposentadoria por idade compulsória (Ex-SASSE)
Aposentadoria por Invalidez
Aposentadoria por invalidez do trabalhador rural
Aposentadoria por invalidez do empregador rural
Aposentadoria por invalidez previdenciária
Aposentadoria por invalidez de aeronauta
Aposentadoria por invalidez de ex-combatente marítimo (Lei nº 1.756/52)
Aposentadoria por invalidez (Extinto Plano Básico)
Aposentadoria por invalidez (Ex-SASSE)
Aposentadoria por tempo de contribuição previdenciária
Aposentadoria por tempo de contribuição de ex-combatente
Aposentadoria por tempo de contribuição de aeronauta
Aposentadoria por tempo de contribuição de jornalista profissional
Aposentadoria por tempo de contribuição especial
Aposentadoria por tempo de contribuição ordinária
Aposentadoria por tempo de contribuição de professor (Emenda Const.18/81)
Apos. por tempo de contribuição de ex-combatente marítimo (Lei 1.756/52)
Aposentadoria por tempo de contribuição (Ex-SASSE)