meutudo Data API: Margin, Loans & Contracts

meutudo · Lending

meutudo is a Brazilian payroll-backed lending app from meutudo that bundles four credit products in one place: empréstimo consignado CLT for private-sector workers, empréstimo consignado INSS for retirees and pensioners, antecipação do Saque-Aniversário do FGTS, and a consignado credit card with a PIX limit. Users run a simulation against their consignable margin, compare installments and rates, complete RG/CNH document capture and a FaceTec liveness selfie, e-sign the CCB with an SMS token, and then track the contract, payment slips and generated PDFs inside the app. It operates only in Brazil, competing for the same INSS and CLT payroll margin as other consignado lenders and correspondents bancários.

INSS benefit records pair nb and nit identifiers with enrollmentName, margin and marginCode. The deduction-capacity breakdown distinguishes availableMargin, usedMargin, reservedMargin, freeMargin and marginFuture, giving payroll-lending brokers and credit-risk teams the components needed for margin monitoring. Simulations select a benefit through enrollment and add installmentValue, installments, monthlyInterest, annualNominalRate, cetYearlyRate and totalAmount for quote comparison.

Accepted proposals are referenced by proposalId during contract preparation. Contract records carry contractNumber, contractStatus (RUNNING, PENDING, PENDENCY, DONE, CANCELLED), dueDate, firstPaymentDate and the disbursement bankAccount with bankCode, agencyNumber, accountNumber and accountDigit. Their installment plan and total can be checked against the simulation, while payment-slip records add installmentNumber and installmentAmount for repayment reconciliation. Identity-document checks and FaceTec liveness sessions use personDocument; document front and back fields, documentType and documentStatus describe the document step, while sessionToken supports the liveness step. Collections teams and Open Finance aggregators can build contract-tracking, onboarding and repayment tools around these records; openData Studio turns the dataset into callable open data.

Screenshots

API surface

The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.

CPF registration lookup
POST /illustrative/v1/payroll-credit/registration-status openbanking
Tells the onboarding flow whether a CPF already has a meutudo account and which agreements (INSS, FGTS) it is enrolled in before password or SMS login.
Auth: None. Public onboarding route on the gateway; the client sends personDocument plus platform/device headers.
- personDocument
- platform
- registered
- personId
- registrationStatus
- agreements
```
POST /illustrative/v1/payroll-credit/registration-status HTTP/1.1
Content-Type: application/json

{
  "personDocument": "12345678909",
  "platform": "APP"
}
```
```
{
  "registered": true,
  "personId": "per_88213",
  "registrationStatus": "IN_PROGRESS",
  "agreements": [
    "inss",
    "fgts"
  ]
}
```
Password login
POST /illustrative/v1/payroll-credit/member-session openbanking
Password sign-in for an already registered CPF; issues the person-scoped bearer token used by contract, margin and document calls.
Auth: None. Credential exchange that returns the access_token the rest of the app sends as 'Bearer '.
- personDocument
- password
- deviceId
- platform
- access_token
- expiresAt
- personId
- personName
```
POST /illustrative/v1/payroll-credit/member-session HTTP/1.1
Content-Type: application/json

{
  "personDocument": "12345678909",
  "password": "<PASSWORD>",
  "deviceId": "<device-id>",
  "platform": "APP"
}
```
```
{
  "access_token": "<ACCESS_TOKEN>",
  "expiresAt": "2026-10-25T18:00:00Z",
  "personId": "per_88213",
  "personName": "Maria Silva"
}
```
SMS token validation
POST /illustrative/v1/payroll-credit/sms-confirmation openbanking
Validates the SMS code sent to the customer's phone during signup, first access, password reset or contract e-signature.
Auth: None. Token is the credential; the same call also serves password recovery and first access.
- personDocument
- smsToken
- deviceId
- access_token
- expiresAt
- registrationStatus
- termsAccepted
```
POST /illustrative/v1/payroll-credit/sms-confirmation HTTP/1.1
Content-Type: application/json

{
  "personDocument": "12345678909",
  "smsToken": "<SMS_CODE>",
  "deviceId": "<device-id>"
}
```
```
{
  "access_token": "<ACCESS_TOKEN>",
  "expiresAt": "2026-10-25T18:00:00Z",
  "registrationStatus": "IN_PROGRESS",
  "termsAccepted": false
}
```
Address by ZIP code
GET /illustrative/v1/payroll-credit/postal-address openbanking
Autocompletes the residential address block of the registration and proof-of-address step from the customer's CEP.
Auth: Bearer access_token from login.
- zipcode
- zipCode
- street
- neighborhood
- city
- state
- complement
```
GET /illustrative/v1/payroll-credit/postal-address?zipcode=01310100 HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
```
```
{
  "zipCode": "01310-100",
  "street": "Avenida Paulista",
  "neighborhood": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "complement": null
}
```
Loan eligibility pre-check
POST /illustrative/v1/payroll-credit/eligibility-check openbanking
Gate before the simulation screen: checks whether the customer has free margin and no open pendency that would block a new payroll loan.
Auth: Bearer access_token from login.
- personDocument
- product
- amount
- canSimulate
- marginCode
- blockedReason
- hasPendencies
```
POST /illustrative/v1/payroll-credit/eligibility-check HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "personDocument": "12345678909",
  "product": "INSS_CONSIGNADO",
  "amount": 5000
}
```
```
{
  "canSimulate": true,
  "marginCode": "MARGIN_OK",
  "blockedReason": null,
  "hasPendencies": false
}
```
INSS benefits list
GET /illustrative/v1/payroll-credit/benefit-enrollments openbanking
Lists the INSS benefits (NB/NIT) linked to the customer so a simulation can be run against a specific aposentadoria, pensão or auxílio.
Auth: Bearer access_token; person is resolved from the token.
- benefits
- nb
- nit
- enrollmentName
- margin
- marginCode
```
GET /illustrative/v1/payroll-credit/benefit-enrollments HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
```
```
{
  "benefits": [
    {
      "nb": "1234567890",
      "nit": "12345678901",
      "enrollmentName": "APOSENTADORIA POR IDADE",
      "margin": 1240.5,
      "marginCode": "MARGIN_OK"
    }
  ]
}
```
INSS margin values
GET /illustrative/v1/payroll-credit/deduction-capacity openbanking
Returns the consignable-margin breakdown for an INSS benefit, the ceiling used to size the loan and to explain a refusal code.
Auth: Bearer access_token.
- availableMargin
- usedMargin
- reservedMargin
- freeMargin
- marginFuture
- marginCode
```
GET /illustrative/v1/payroll-credit/deduction-capacity?enrollment=1234567890 HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
```
```
{
  "availableMargin": 1240.5,
  "usedMargin": 310.0,
  "reservedMargin": 0,
  "freeMargin": 930.5,
  "marginFuture": 155.2,
  "marginCode": "MARGIN_OK"
}
```

Loan simulation

POST /illustrative/v1/payroll-credit/repayment-estimate openbanking

Prices a payroll loan against the customer's margin and returns installment, interest and CET figures that feed the simulation and comparison screens.

Auth: Bearer access_token.

product
amount
installments
enrollment
proposalValue
installmentValue
monthlyInterest
annualInterest
annualNominalRate
cetYearlyRate
cetMontlhyRate
totalAmount
firstPaymentDate

POST /illustrative/v1/payroll-credit/repayment-estimate HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "product": "INSS_CONSIGNADO",
  "amount": 5000,
  "installments": 84,
  "enrollment": "1234567890"
}

{
  "proposalValue": 5000,
  "installmentValue": 92.4,
  "installments": 84,
  "monthlyInterest": 1.79,
  "annualInterest": 23.7,
  "annualNominalRate": 23.7,
  "cetYearlyRate": 28.4,
  "cetMontlhyRate": 2.1,
  "totalAmount": 7761.6,
  "firstPaymentDate": "2026-11-10"
}

INSS simulation (PIX consignado / future margin)

POST /illustrative/v1/payroll-credit/special-inss-estimate openbanking

Runs the newer INSS simulation flavours — consignado PIX and future-margin — and returns the proposal the customer can accept.

Auth: Bearer access_token.

type
enrollment
amount
installments
proposalId
proposalValue
installmentValue
firstPaymentDate

POST /illustrative/v1/payroll-credit/special-inss-estimate?type=CONSIGNED_PIX HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "enrollment": "1234567890",
  "amount": 3000,
  "installments": 60
}

{
  "proposalId": "prop_99120",
  "proposalValue": 3000,
  "installmentValue": 61.5,
  "installments": 60,
  "firstPaymentDate": "2026-11-10"
}

Prepare contract

POST /illustrative/v1/payroll-credit/contract-preparation openbanking

Turns an accepted proposal into a contract record and fixes the disbursement bank account before documents and signature.

Auth: Bearer access_token.

proposalId
personDocument
installmentNumber
bankAccount
bankCode
agencyNumber
accountNumber
accountDigit
accountType
contractId
contractNumber
contractStatus
contractDate

POST /illustrative/v1/payroll-credit/contract-preparation HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "proposalId": "prop_99120",
  "personDocument": "12345678909",
  "installmentNumber": 60,
  "bankAccount": {
    "bankCode": "260",
    "agencyNumber": "0001",
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountType": "CHECKING"
  }
}

{
  "contractId": "ctr_55120",
  "contractNumber": "202600055120",
  "contractStatus": "PENDING",
  "contractDate": "2026-10-25"
}

Suggested proposals
GET /illustrative/v1/payroll-credit/suggested-offers openbanking
Returns the pre-approved proposal set generated for the customer, including refinance and portability variants shown on the offers screens.
Auth: Bearer access_token.
- proposals
- proposalId
- proposalValue
- installments
- installmentValue
- monthlyInterest
```
GET /illustrative/v1/payroll-credit/suggested-offers HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
```
```
{
  "proposals": [
    {
      "proposalId": "prop_99120",
      "proposalValue": 5000,
      "installments": 84,
      "installmentValue": 92.4,
      "monthlyInterest": 1.79
    }
  ]
}
```

Upload and validate personal document

POST /illustrative/v1/payroll-credit/identity-document-check openbanking

Uploads RG/CNH front and back images and runs the OCR/validation step that gates contract formalization.

Auth: Bearer access_token; multipart upload of document images.

documentType
file
documentStatus
personDocument
documentFront
documentBack

POST /illustrative/v1/payroll-credit/identity-document-check HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: multipart/form-data; boundary=----meutudo

------meutudo
Content-Disposition: form-data; name="documentType"

RG_FRONT
------meutudo
Content-Disposition: form-data; name="file"; filename="rg.jpg"
Content-Type: image/jpeg

<binary>
------meutudo--

{
  "documentType": "RG_FRONT",
  "documentStatus": "APPROVED",
  "personDocument": "12345678909"
}

FaceTec biometric session
POST /illustrative/v1/payroll-credit/liveness-session openbanking
Issues the FaceTec session token used for the 3D liveness/face-match step in onboarding, contract signature and PIX biometry.
Auth: Bearer access_token. The returned sessionToken is then used by the FaceTec 3D liveness SDK.
- personDocument
- sessionToken
```
POST /illustrative/v1/payroll-credit/liveness-session HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "personDocument": "12345678909"
}
```
```
{
  "sessionToken": "<SESSION_TOKEN>"
}
```

Contract detail

GET /illustrative/v1/payroll-credit/contract-record openbanking

Opens one contract's status, installment plan, first payment and disbursement account for the contract detail screen.

Auth: Bearer access_token.

contractNumber
contractId
contractStatus
installmentValue
installments
firstPaymentDate
dueDate
totalAmount
bankAccount
bankCode
agencyNumber
accountNumber
accountDigit

GET /illustrative/v1/payroll-credit/contract-record?contractNumber=202600055120 HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>

{
  "contractId": "ctr_55120",
  "contractNumber": "202600055120",
  "contractStatus": "RUNNING",
  "installmentValue": 92.4,
  "installments": 84,
  "firstPaymentDate": "2026-11-10",
  "dueDate": "2026-11-10",
  "totalAmount": 7761.6,
  "bankAccount": {
    "bankCode": "260",
    "agencyNumber": "0001",
    "accountNumber": "123456",
    "accountDigit": "7"
  }
}

Payment slip (boleto)

GET /illustrative/v1/payroll-credit/installment-slip openbanking

Fetches the boleto/payment slip for the next or a chosen installment of a running contract.

Auth: Bearer access_token.

contractNumber
installmentNumber
dueDate
installmentAmount
totalAmount

GET /illustrative/v1/payroll-credit/installment-slip?contractNumber=202600055120 HTTP/1.1
Authorization: Bearer <ACCESS_TOKEN>

{
  "contractNumber": "202600055120",
  "installmentNumber": 3,
  "dueDate": "2027-01-10",
  "installmentAmount": 92.4,
  "totalAmount": 92.4
}

Where teams use this data

Consignable-margin monitoring
Track availableMargin, usedMargin, reservedMargin and marginFuture per INSS benefit keyed by nb, nit and marginCode, so a broker or credit team sees when free margin opens up before a new simulation.
Quote-vs-contract reconciliation
Compare the installmentValue, monthlyInterest, cetYearlyRate and totalAmount returned by a simulation with the contractStatus, firstPaymentDate and installments booked on the resulting contract.
Onboarding and KYC pipeline
Wire the registration steps together: CPF lookup, SMS smsToken validation, ZIP-code address fill (zipCode, street, neighborhood, city, state), document front/back upload and the FaceTec sessionToken for liveness.
Repayment and disbursement tracking
Read contractNumber, dueDate, installmentAmount and the disbursement bankAccount fields (bankCode, agencyNumber, accountNumber, accountDigit) to reconcile payroll deductions and payment slips.

Frequently asked questions

What payroll-loan data does meutudo expose?

INSS margin breakdowns (availableMargin, usedMargin, reservedMargin, marginFuture), benefit identifiers (nb, nit), simulation quotes (installmentValue, monthlyInterest, cetYearlyRate, totalAmount), proposals and contract records (contractNumber, contractStatus, dueDate, firstPaymentDate).

Which INSS simulation variants are represented?

The examples include a payroll-loan simulation using product INSS_CONSIGNADO and an INSS-specific simulation for PIX consignado or future-margin proposals. The illustrated PIX request uses type CONSIGNED_PIX; its response contains proposalId, proposalValue, installmentValue, installments and firstPaymentDate.

How is a customer identified across calls?

personDocument (CPF) identifies the customer in registration, document checks and biometric-session requests. Authenticated calls carry a bearer access_token. INSS simulations select the benefit with enrollment, while the benefit list supplies nb, nit and enrollmentName; these identifiers are not all sent on every request.

Does the surface include repayment data?

Yes — contract detail returns installments, installmentValue and firstPaymentDate, and the payment-slip call returns installmentNumber, dueDate and installmentAmount for the boleto of a given installment.

Apps similar to meutudo. Empréstimo CLT e INSS

Banco Bmg — Banco Bmg offers empréstimo consignado for INSS retirees and pensioners with installments deducted from the benefit (up to 108 parcels) and a separate consignado CLT line for formally employed workers with salary deductions of up to 60 installments.
Creditas — Creditas's Empréstimo Consignado Privado (Crédito do Trabalhador) is a CLT payroll loan with installments withheld from wages, offered from R$500 with terms of 6 to 48 months via the Creditas app or CTPS Digital.
Agibank — Agibank lists consignado for public-sector employees (servidor público), Crédito do Trabalhador, and consignado portability, with applications through its app and a national branch network.
Facio — Facio (Facio Pagamentos) offers Crédito Fácil personal credit in Brazil as a correspondent of QI Tech SCD, depositing a credit-assessed amount into the borrower's account for repayment in a single installment on a chosen date.
Serasa: Consulta CPF e Score — Serasa's consumer app lets Brazilians check CPF records and Serasa Score, negotiate overdue debts through Limpa Nome, and simulate credit-card, personal-loan and consignado-privado offers in its marketplace.
Crediamigo — Crediamigo is Banco do Nordeste's urban microcredit programme for small entrepreneurs, offering working-capital, fixed-investment and women-entrepreneur credit lines that customers can follow in the Crediamigo app.

More Lending apps

Topics

meutudo Data API
empréstimo consignado INSS API
INSS benefit margin data
margem consignável
payroll loan simulation API
boleto repayment data
contrato consignado
Brazil lending data

Need this app's data API integrated?

We deliver scoped integrations for any named app — from USD 500 with source-code handoff, or hosted access billed per call. Tell us the data you need.

NDA + SOW on every engagement
Delivery in 3–7 days
Payment only after acceptance
Work scoped to authorized use

Get a quote

meutudo Data API: Margin, Loans & Contracts

Screenshots

API surface

CPF registration lookup

Password login

SMS token validation

Address by ZIP code

Loan eligibility pre-check

INSS benefits list

INSS margin values

Loan simulation

INSS simulation (PIX consignado / future margin)

Prepare contract

Suggested proposals

Upload and validate personal document

FaceTec biometric session

Contract detail

Payment slip (boleto)

Data categories

Where teams use this data

Consignable-margin monitoring

Quote-vs-contract reconciliation

Onboarding and KYC pipeline

Repayment and disbursement tracking

Frequently asked questions

Apps similar to meutudo. Empréstimo CLT e INSS

More Lending apps

BAF Mobile - Cicilan Pinjaman

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

Topics

Need this app's data API integrated?

meutudo Data API: Margin, Loans & Contracts

Screenshots

API surface

CPF registration lookup

Password login

SMS token validation

Address by ZIP code

Loan eligibility pre-check

INSS benefits list

INSS margin values

Loan simulation

INSS simulation (PIX consignado / future margin)

Prepare contract

Suggested proposals

Upload and validate personal document

FaceTec biometric session

Contract detail

Payment slip (boleto)

Data categories

Where teams use this data

Consignable-margin monitoring

Quote-vs-contract reconciliation

Onboarding and KYC pipeline

Repayment and disbursement tracking

Frequently asked questions

Related apps

Apps similar to meutudo. Empréstimo CLT e INSS

More Lending apps

BAF Mobile - Cicilan Pinjaman

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

Topics

Need this app's data API integrated?