Crediamigo Data API

Banco do Nordeste do Brasil · Lending

Crediamigo is the official client app of Banco do Nordeste's Crediamigo microcredit programme, the state-owned development bank's flagship lending line for small entrepreneurs, informal traders and family businesses, running since 1998 and widely described as Latin America's largest microcredit operation. It covers the full borrowing cycle: a CPF-and-password login, a credit-limit view, a simulation of loan size against installment count and rate, pre-approved offer screens, electronic contract signing, a per-contract installment schedule, boleto and Pix repayment, payment receipts, an account statement, the Crediamigo card, referral of new clients, an agent and agency locator, and an open-finance consent area for sharing data with other institutions. The programme reported 2.13 million clients with active loans at mid-2025, 68% of them women, and serves microentrepreneurs concentrated in Brazil's Northeast with a growing national footprint; it is published for Brazil only and competes with other Brazilian microcredit and digital-lending providers for the same informal-economy borrowers.

Crediamigo installment schedules group numeroParcela, valorParcela, dataVencimento and statusParcela under a contratoId, alongside the outstanding balance in saldoDevedor. Credit-limit records separately provide limiteDisponivel, limiteTotal, valorUtilizado and taxaJurosMensal; borrower profiles identify the registration and servicing relationship through situacaoCadastral, codigoAgencia and nomeAgente. A loan simulation returns valorSolicitado, valorParcela, cet and valorTotalPago for the chosen quantidadeParcelas, while pre-approved offers pair ofertaId with statusOferta and dataValidade.

Repayment artifacts are equally structured: a boleto exposes linhaDigitavel, codigoBarras, valorDocumento and beneficiario. Pix payment submissions specify parcelaId, valorPix and chavePix; the returned payment record carries txid, statusPagamento, dataPagamento and comprovanteId. Statement entries log tipoMovimento values such as CREDITO_PARCELA and DEBITO_PARCELA alongside valorMovimento and saldoApos. Card records add numeroCartaoMascarado, faturaAtual and vencimentoFatura, while open-finance consents track consentId, statusConsentimento, instituicaoDestino, dataExpiracao and escopo.

With borrower authorization, credit analysts, collections desks, accounting platforms and personal-finance aggregators can use these fields to reconcile a borrower's loan book, automate repayment reminders and assess renewals. Open-finance consent status and expiry can inform sharing controls; openData Studio turns these records into callable open data for such integrations.

Screenshots

API surface

Request/response examples are illustrative, reconstructed from the app's interface — not a live capture.

Client authentication

POST /v1/crediamigo/auth/login openbanking

Exchanges the borrower's CPF and password for the session token that unlocks limit, contract, installment and payment screens.

Auth: None. CPF plus access password mint a Bearer JWT; every later call sends Authorization: Bearer.

cpf
senha
deviceId
canal
accessToken
refreshToken
tokenType
expiresIn
clienteId
primeiroAcesso

POST /v1/crediamigo/auth/login HTTP/1.1
Content-Type: application/json

{
  "cpf": "12345678901",
  "senha": "********",
  "deviceId": "a1b2c3d4-e5f6-7890",
  "canal": "APP"
}

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo",
  "refreshToken": "rt_cred_7f28c1",
  "tokenType": "Bearer",
  "expiresIn": 3600,
  "clienteId": "CLI-20481937",
  "primeiroAcesso": false
}

Borrower profile

GET /v1/crediamigo/clientes/{cpf}/perfil osint

Returns the registered microentrepreneur's identity, contact details, cadastral status and the agency or field agent responsible for the relationship.

Auth: Bearer token from /v1/crediamigo/auth/login.

clienteId
nomeCompleto
cpf
dataNascimento
email
telefone
situacaoCadastral
codigoAgencia
nomeAgente

GET /v1/crediamigo/clientes/12345678901/perfil HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "clienteId": "CLI-20481937",
  "nomeCompleto": "Maria da Silva Santos",
  "cpf": "12345678901",
  "dataNascimento": "1987-04-12",
  "email": "[email protected]",
  "telefone": "11987654321",
  "situacaoCadastral": "ATIVA",
  "codigoAgencia": "0182",
  "nomeAgente": "Agente Crediamigo Recife Centro"
}

Credit limit
GET /v1/crediamigo/clientes/{cpf}/limite-credito openfinance
Reads the borrower's approved credit ceiling, the unused portion and the monthly rate that constrains the next loan.
Auth: Bearer token from /v1/crediamigo/auth/login.
- limiteTotal
- limiteDisponivel
- valorUtilizado
- taxaJurosMensal
- prazoMaximoMeses
- dataAtualizacao
```
GET /v1/crediamigo/clientes/12345678901/limite-credito HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo
```
```
{
  "limiteTotal": 8000.00,
  "limiteDisponivel": 5200.00,
  "valorUtilizado": 2800.00,
  "taxaJurosMensal": 1.89,
  "prazoMaximoMeses": 24,
  "dataAtualizacao": "2026-10-20"
}
```

Loan simulation

POST /v1/crediamigo/simulacoes openfinance

Prices a prospective loan, returning the installment amount, monthly rate, total effective cost and total repayment for the chosen term.

Auth: Bearer token from /v1/crediamigo/auth/login.

simulacaoId
valorSolicitado
quantidadeParcelas
valorParcela
taxaJurosMensal
cet
valorTotalPago
dataPrimeiroVencimento

POST /v1/crediamigo/simulacoes HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo
Content-Type: application/json

{
  "valorSolicitado": 5000.00,
  "quantidadeParcelas": 12,
  "finalidade": "CAPITAL_GIRO",
  "dataPrimeiroVencimento": "2026-11-15"
}

{
  "simulacaoId": "SIM-908231",
  "valorSolicitado": 5000.00,
  "quantidadeParcelas": 12,
  "valorParcela": 478.35,
  "taxaJurosMensal": 1.89,
  "cet": 2.41,
  "valorTotalPago": 5740.20,
  "dataPrimeiroVencimento": "2026-11-15"
}

Pre-approved offers

GET /v1/crediamigo/ofertas-credito openfinance

Lists the pre-qualified credit offers waiting for the borrower, with amount, term, rate and expiry date.

Auth: Bearer token from /v1/crediamigo/auth/login.

ofertaId
valorOfertado
quantidadeParcelas
taxaJurosMensal
statusOferta
dataValidade

GET /v1/crediamigo/ofertas-credito HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "ofertas": [
    {
      "ofertaId": "OFT-552810",
      "valorOfertado": 6000.00,
      "quantidadeParcelas": 18,
      "taxaJurosMensal": 1.75,
      "statusOferta": "DISPONIVEL",
      "dataValidade": "2026-11-30"
    }
  ]
}

Contract a loan

POST /v1/crediamigo/contratos openfinance

Submits the accepted offer with its electronic signature and creates the loan contract that generates the installment plan.

Auth: Bearer token from /v1/crediamigo/auth/login.

ofertaId
valorContratado
quantidadeParcelas
aceiteTermos
assinaturaEletronica
contratoId
numeroContrato
statusContrato
dataContratacao
dataPrimeiroVencimento

POST /v1/crediamigo/contratos HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo
Content-Type: application/json

{
  "ofertaId": "OFT-552810",
  "valorContratado": 6000.00,
  "quantidadeParcelas": 18,
  "aceiteTermos": true,
  "assinaturaEletronica": "ASS-9c41f7d2",
  "dataPrimeiroVencimento": "2026-12-10"
}

{
  "contratoId": "CTR-771204",
  "numeroContrato": "2026.0044182",
  "statusContrato": "EM_ANDAMENTO",
  "valorContratado": 6000.00,
  "dataContratacao": "2026-10-25",
  "dataPrimeiroVencimento": "2026-12-10",
  "quantidadeParcelas": 18
}

Installment schedule

GET /v1/crediamigo/contratos/{contratoId}/parcelas openfinance

Returns every installment of a contract with due date, open or paid status, amount paid and days overdue, plus the outstanding balance.

Auth: Bearer token from /v1/crediamigo/auth/login.

contratoId
saldoDevedor
parcelaId
numeroParcela
valorParcela
dataVencimento
statusParcela
valorPago
diasAtraso

GET /v1/crediamigo/contratos/CTR-771204/parcelas HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "contratoId": "CTR-771204",
  "saldoDevedor": 5420.80,
  "parcelas": [
    {
      "parcelaId": "PRC-1188201",
      "numeroParcela": 1,
      "valorParcela": 478.35,
      "dataVencimento": "2026-12-10",
      "statusParcela": "ABERTA",
      "valorPago": 0.00,
      "diasAtraso": 0
    }
  ]
}

Installment boleto

GET /v1/crediamigo/parcelas/{parcelaId}/boleto openbanking

Issues the payment slip for one installment with its typeable line, barcode and due date for bank or app payment.

Auth: Bearer token from /v1/crediamigo/auth/login.

boletoId
linhaDigitavel
codigoBarras
valorDocumento
dataVencimento
beneficiario
statusBoleto

GET /v1/crediamigo/parcelas/PRC-1188201/boleto HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "boletoId": "BOL-4402817",
  "linhaDigitavel": "75691.00012 34567.890123 45678.901234 5 98760000047835",
  "codigoBarras": "75695987600000478351000012345678901234567890",
  "valorDocumento": 478.35,
  "dataVencimento": "2026-12-10",
  "beneficiario": "Banco do Nordeste do Brasil S.A.",
  "statusBoleto": "EMITIDO"
}

Pay installment with Pix

POST /v1/crediamigo/pagamentos/pix openbanking

Registers an installment repayment by Pix, returning the transaction id, settlement status, receipt id and copy-and-paste QR payload.

Auth: Bearer token from /v1/crediamigo/auth/login.

parcelaId
valorPix
chavePix
txid
statusPagamento
dataPagamento
comprovanteId
qrCodePayload

POST /v1/crediamigo/pagamentos/pix HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo
Content-Type: application/json

{
  "parcelaId": "PRC-1188201",
  "valorPix": 478.35,
  "chavePix": "[email protected]",
  "txid": "CRED202612101188201"
}

{
  "txid": "CRED202612101188201",
  "statusPagamento": "CONCLUIDO",
  "valorPix": 478.35,
  "dataPagamento": "2026-12-08T14:32:07-03:00",
  "comprovanteId": "CMP-9033771",
  "qrCodePayload": "00020126580014br.gov.bcb.pix..."
}

Account statement

GET /v1/crediamigo/extrato openbanking

Streams the borrower's credit-account movements — disbursements, installment debits and boleto deposits — with running balance.

Auth: Bearer token from /v1/crediamigo/auth/login.

saldoAtual
dataMovimento
tipoMovimento
descricaoLancamento
valorMovimento
saldoApos

GET /v1/crediamigo/extrato?dataInicio=2026-09-01&dataFim=2026-10-25 HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "saldoAtual": 1204.50,
  "movimentos": [
    {
      "dataMovimento": "2026-10-05",
      "tipoMovimento": "CREDITO_PARCELA",
      "descricaoLancamento": "Liberacao parcela contrato 2026.0044182",
      "valorMovimento": 6000.00,
      "saldoApos": 6000.00
    },
    {
      "dataMovimento": "2026-10-08",
      "tipoMovimento": "DEBITO_PARCELA",
      "descricaoLancamento": "Pagamento parcela 1/18",
      "valorMovimento": -478.35,
      "saldoApos": 5521.65
    }
  ]
}

Crediamigo card

GET /v1/crediamigo/cartao openbanking

Returns the Crediamigo card's masked number, status, credit limit, current statement balance and due date.

Auth: Bearer token from /v1/crediamigo/auth/login.

cartaoId
numeroCartaoMascarado
statusCartao
limiteCartao
limiteDisponivel
faturaAtual
vencimentoFatura
melhorDiaCompra

GET /v1/crediamigo/cartao HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "cartaoId": "CRD-660214",
  "numeroCartaoMascarado": "**** **** **** 4419",
  "statusCartao": "ATIVO",
  "limiteCartao": 1500.00,
  "limiteDisponivel": 980.00,
  "faturaAtual": 520.00,
  "vencimentoFatura": "2026-11-05",
  "melhorDiaCompra": 25
}

Open-finance consents

GET /v1/crediamigo/open-finance/consentimentos openfinance

Lists the borrower's open-finance data-sharing consents, their status, destination institution, expiry and shared scopes.

Auth: OAuth2 consent flow; calls carry the Bearer token from /v1/crediamigo/auth/login.

consentId
statusConsentimento
instituicaoDestino
dataCriacao
dataExpiracao
escopo

GET /v1/crediamigo/open-finance/consentimentos HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.crediamigo

{
  "consentimentos": [
    {
      "consentId": "urn:bbn:consent:4f81c2",
      "statusConsentimento": "AUTHORISED",
      "instituicaoDestino": "Banco Exemplo S.A.",
      "dataCriacao": "2026-07-14T09:12:00-03:00",
      "dataExpiracao": "2027-07-14T09:12:00-03:00",
      "escopo": ["accounts", "credit-cards", "loans"]
    }
  ]
}

Where teams use this data

Microcredit portfolio monitoring
Lenders and development-finance teams pull limiteDisponivel, saldoDevedor, statusParcela and diasAtraso per contract to track repayment health across thousands of informal-economy borrowers without waiting for monthly returns.
Collections and boleto automation
Collections tools read linhaDigitavel, codigoBarras, valorDocumento and dataVencimento for each open parcela, schedule reminders, then confirm settlement from txid, valorPago and the receipt's autenticacao.
Renewal and underwriting signals
Credit models combine simulated taxaJurosMensal and cet with paid-installment history (numeroParcela, dataVencimento, valorPago) and open ofertaId offers to time the next Crediamigo renewal.
Open-finance aggregation
PFM apps and aggregators reconcile consentId, statusConsentimento and instituicaoDestino with statement rows such as tipoMovimento, valorMovimento and saldoApos to build a complete picture of a microentrepreneur's credit position.

Frequently asked questions

Which credit and repayment data does the Crediamigo API cover?

The documented fields cover borrower profiles (nomeCompleto, cpf, situacaoCadastral, codigoAgencia), credit limits (limiteTotal, limiteDisponivel, valorUtilizado), loan simulations (valorSolicitado, valorParcela, taxaJurosMensal, cet, valorTotalPago), pre-approved offers, contracts, installment schedules, boleto records and Pix payments. Card data, account statements and open-finance consent records are also included.

Can Crediamigo installment schedules be retrieved in bulk?

The documented schedule is per contratoId; no bulk retrieval operation is shown. It returns saldoDevedor and installment rows containing numeroParcela, dataVencimento, valorParcela, statusParcela, valorPago and diasAtraso. An authorized integration can process each available contract's schedule to build a repayment calendar, but the fields do not include a principal-and-interest breakdown.

Which fields support boleto and Pix repayment reconciliation?

A boleto record includes boletoId, linhaDigitavel, codigoBarras, valorDocumento, dataVencimento and statusBoleto. Pix payment submissions identify parcelaId; returned fields include txid, statusPagamento, valorPix, dataPagamento and comprovanteId. The installment schedule separately supplies statusParcela and valorPago so an integration can compare the payment record with the installment's recorded state.

Is borrower data public, and which consent details are available?

No. The documented borrower operations require an authenticated session, and access should be limited to authorized records. Open-finance consent records include consentId, statusConsentimento, instituicaoDestino, dataCriacao, dataExpiracao and escopo. These describe the receiving institution, authorization status, validity and shared categories; their presence does not itself grant access to another borrower's data.

Apps similar to Crediamigo

Agroamigo — Agroamigo is Banco do Nordeste's rural microcredit programme for family farmers, offering guided productive credit for on-farm investment such as water infrastructure, solar power and machinery, with dedicated lines for women and young farmers.
meutudo. Empréstimo CLT e INSS — meutudo is a Brazilian digital lender (TUDO Serviços S.A.) for payroll-backed consignado loans to CLT workers and INSS retirees, plus FGTS saque-aniversário advances and payroll credit cards, contracted through its app and website.
Facio — Facio is a Brazilian cash-credit app from Facio Pagamentos Ltda, a banking correspondent of QI Tech, that registers applicants to reveal a personal credit limit, advertises disbursement in about two minutes, and lets borrowers repay in a single instalment on a chosen date.
Serasa Crédito — Serasa Crédito is Serasa's free CPF-based marketplace, used from the Serasa consumer app or site, that shows personal-loan and card offers from more than 40 partner lenders so borrowers can simulate amount and term and compare conditions before applying.

More Lending apps

Topics

Crediamigo API
Banco do Nordeste microcredit
Crediamigo endpoints
limite de credito API
Crediamigo parcelas
boleto Crediamigo
Pix microcredito
open finance BNB

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

Crediamigo Data API

Screenshots

API surface

Client authentication

Borrower profile

Credit limit

Loan simulation

Pre-approved offers

Contract a loan

Installment schedule

Installment boleto

Pay installment with Pix

Account statement

Crediamigo card

Open-finance consents

Data categories

Where teams use this data

Microcredit portfolio monitoring

Collections and boleto automation

Renewal and underwriting signals

Open-finance aggregation

Frequently asked questions

Apps similar to Crediamigo

More Lending apps

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

CASHe: Quick Personal Loan App

Topics

Need this app's data API integrated?

Crediamigo Data API

Screenshots

API surface

Client authentication

Borrower profile

Credit limit

Loan simulation

Pre-approved offers

Contract a loan

Installment schedule

Installment boleto

Pay installment with Pix

Account statement

Crediamigo card

Open-finance consents

Data categories

Where teams use this data

Microcredit portfolio monitoring

Collections and boleto automation

Renewal and underwriting signals

Open-finance aggregation

Frequently asked questions

Related apps

Apps similar to Crediamigo

More Lending apps

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

CASHe: Quick Personal Loan App

Topics

Need this app's data API integrated?