Crediamigo 数据 API

Banco do Nordeste do Brasil · 信贷

Crediamigo 是巴西东北银行（Banco do Nordeste do Brasil）旗下 Crediamigo 小额信贷计划的官方客户端。该计划自 1998 年起运营，是这家国有开发银行面向小微创业者、非正规经营商户及家庭企业的旗舰信贷项目，被广泛称为拉丁美洲规模最大的小额信贷业务。应用覆盖完整借贷周期：使用 CPF 与密码登录、查看信贷额度、按贷款金额、分期期数及利率进行试算、浏览预审批贷款方案、电子签署合同、查看各合同的分期还款计划、通过 boleto 或 Pix 还款、获取付款收据、查询账户流水、查看 Crediamigo 卡片、推荐新客户、查找客户经理与服务网点，以及在开放金融授权专区管理向其他机构共享数据的授权。截至 2025 年年中，该计划公布的有在贷余额客户数为 213 万，其中女性占 68%。其服务对象主要集中在巴西东北部，业务覆盖正向全国扩展；应用仅在巴西发布，与其他巴西小额信贷及数字借贷服务商共同服务非正规经济中的借款人。

Crediamigo 分期还款计划以 contratoId 归集各期的 numeroParcela、valorParcela、dataVencimento 与 statusParcela，并提供 saldoDevedor 所表示的未偿余额。信贷额度记录另行提供 limiteDisponivel、limiteTotal、valorUtilizado 与 taxaJurosMensal；借款人档案则通过 situacaoCadastral、codigoAgencia 和 nomeAgente 标识登记状态与服务归属。贷款试算根据所选的 quantidadeParcelas 返回 valorSolicitado、valorParcela、cet 和 valorTotalPago，预审批贷款方案则将 ofertaId 与 statusOferta、dataValidade 配对。

还款凭据同样具有明确结构：boleto 付款单包含 linhaDigitavel、codigoBarras、valorDocumento 和 beneficiario。Pix 付款提交内容指定 parcelaId、valorPix 与 chavePix，返回的支付记录包含 txid、statusPagamento、dataPagamento 和 comprovanteId。账户流水通过 tipoMovimento 记录 CREDITO_PARCELA、DEBITO_PARCELA 等变动类型，并附有 valorMovimento 与 saldoApos。卡片记录还包含 numeroCartaoMascarado、faturaAtual 和 vencimentoFatura，开放金融授权则记录 consentId、statusConsentimento、instituicaoDestino、dataExpiracao 与 escopo。

在取得借款人授权的前提下，信贷分析师、催收团队、会计平台及个人财务数据聚合服务可利用这些字段核对贷款账目、自动发送还款提醒并评估续贷。开放金融授权的状态与有效期可为共享控制提供依据；openData Studio 将这些记录转化为可调用的开放数据，支持此类集成。

应用截图

API 端点一览

请求/响应示例为依据应用界面重构的示意示例，并非实时抓包。

客户身份认证

POST /v1/crediamigo/auth/login openbanking

使用借款人的 CPF 与密码换取会话令牌，以访问额度、合同、分期及支付界面。

认证方式：无需事先认证。使用 CPF 与访问密码获取 Bearer JWT；此后的每次调用均发送 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
}

借款人档案

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

返回已登记微型创业者的身份、联系方式、登记状态，以及负责客户关系的网点或客户经理。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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"
}

信贷额度
GET /v1/crediamigo/clientes/{cpf}/limite-credito openfinance
读取借款人获批的信贷总额度、尚未使用的额度，以及下一笔贷款适用的月利率。
认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。
- 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"
}
```

贷款试算

POST /v1/crediamigo/simulacoes openfinance

根据所选期限试算拟申请的贷款，返回每期还款额、月利率、综合有效成本及还款总额。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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"
}

预审批贷款方案

GET /v1/crediamigo/ofertas-credito openfinance

列出借款人可选的预审批贷款方案，包括金额、期限、利率与有效期。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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"
    }
  ]
}

签订贷款合同

POST /v1/crediamigo/contratos openfinance

提交已接受的贷款方案及电子签名，创建贷款合同并生成分期还款计划。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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
}

分期还款计划

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

返回合同各期还款的到期日、未还或已还状态、已付金额与逾期天数，以及尚欠余额。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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
    }
  ]
}

分期付款单

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

为单期还款生成 boleto 付款单，提供可手动输入的付款码、条形码与到期日，供银行或应用内支付使用。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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"
}

Pix 分期还款

POST /v1/crediamigo/pagamentos/pix openbanking

登记通过 Pix 支付的分期还款，返回交易标识、结算状态、收据标识及可复制粘贴的二维码载荷。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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..."
}

账户流水

GET /v1/crediamigo/extrato openbanking

提供借款人信贷账户的连续流水，包括贷款发放、分期还款扣款与 boleto 入账，以及逐笔变动后的余额。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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 卡片

GET /v1/crediamigo/cartao openbanking

返回 Crediamigo 卡片的脱敏卡号、状态、信贷额度、当期账单余额及还款到期日。

认证方式：使用从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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
}

开放金融授权

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

列出借款人的开放金融数据共享授权，包括授权状态、接收机构、有效期与共享范围。

认证方式：采用 OAuth2 授权流程；调用时携带从 /v1/crediamigo/auth/login 获取的 Bearer 令牌。

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"]
    }
  ]
}

数据类别

借款人档案
信贷额度
贷款试算
预审批贷款方案
贷款合同
分期还款计划
boleto 付款单
Pix 还款
账户流水
付款收据
Crediamigo 卡片
开放金融授权

数据使用场景与案例

小额信贷组合监测
贷款机构与开发金融团队可按合同提取 limiteDisponivel、saldoDevedor、statusParcela 和 diasAtraso，跟踪数千名非正规经济借款人的还款状况，无需等待月度报告。
催收与 boleto 流程自动化
催收工具可读取各笔未还分期 parcela 的 linhaDigitavel、codigoBarras、valorDocumento 和 dataVencimento，安排还款提醒，再结合 txid、valorPago 与收据中的 autenticacao 确认结算。
续贷与授信评估信号
信贷模型可将试算得到的 taxaJurosMensal、cet，与已还分期历史中的 numeroParcela、dataVencimento、valorPago 及尚可选择的 ofertaId 贷款方案结合，判断下一次 Crediamigo 续贷的时机。
开放金融数据聚合
个人财务管理应用与数据聚合平台可将 consentId、statusConsentimento 和 instituicaoDestino，与流水记录中的 tipoMovimento、valorMovimento、saldoApos 对照，形成微型创业者信贷状况的完整视图。

常见问题

Crediamigo API 涵盖哪些信贷与还款数据？

已列出的字段涵盖借款人档案（nomeCompleto、cpf、situacaoCadastral、codigoAgencia）、信贷额度（limiteTotal、limiteDisponivel、valorUtilizado）、贷款试算（valorSolicitado、valorParcela、taxaJurosMensal、cet、valorTotalPago）、预审批贷款方案、合同、分期还款计划、boleto 记录及 Pix 支付，也包括卡片数据、账户流水和开放金融授权记录。

能否批量获取 Crediamigo 的分期还款计划？

当前说明按单个 contratoId 获取计划，未列出批量获取操作。结果包含 saldoDevedor，以及各期的 numeroParcela、dataVencimento、valorParcela、statusParcela、valorPago 和 diasAtraso。经授权的集成可逐份处理可访问合同的计划，构建还款日历；这些字段并未提供本金与利息的分项明细。

哪些字段可用于 boleto 与 Pix 还款对账？

boleto 记录包含 boletoId、linhaDigitavel、codigoBarras、valorDocumento、dataVencimento 和 statusBoleto。Pix 付款提交内容通过 parcelaId 指明分期，返回字段包括 txid、statusPagamento、valorPix、dataPagamento 与 comprovanteId。分期还款计划另行提供 statusParcela 和 valorPago，集成系统可据此对照支付记录与该期已登记的还款状态。

借款人数据是否公开？可以查看哪些授权信息？

不公开。此处列出的借款人操作需要登录认证，访问应限于已获授权的记录。开放金融授权记录包含 consentId、statusConsentimento、instituicaoDestino、dataCriacao、dataExpiracao 和 escopo，描述接收机构、授权状态、有效期与共享类别；存在这些字段并不意味着可以访问其他借款人的数据。

与 Crediamigo 相似的应用

Agroamigo — Agroamigo 是巴西东北银行面向家庭农户的农村小额信贷项目，为田间生产提供配套指导贷款，覆盖水利、太阳能和农机等投入，并设有面向女性和青年农户的专项额度。
meutudo. Empréstimo CLT e INSS — meutudo 是巴西数字放贷平台（TUDO Serviços S.A.），通过应用和网站办理面向正式雇员（CLT）和 INSS 退休人员的工资代扣贷款，以及 FGTS 生日取款预支和工资信用卡。
Facio — Facio 是 Facio Pagamentos Ltda（QI Tech 的银行业务代理）推出的巴西现金信贷应用，注册后可查看个人信贷额度，宣传约两分钟放款，并可在自选日期一次性还款。
Serasa Crédito — Serasa Crédito 是 Serasa 免费的 CPF 信贷比价入口，可在消费端应用或网站使用，会展示 40 多家合作机构的个人贷款和信用卡报价，借款人可先模拟金额与期限、比较条件再申请。

需要集成这个 App 的数据 API？

我们可为任意指定 App 交付定制集成——源码交付 USD 500 起，或托管 API 按调用计费。告诉我们您需要的数据即可。

每个项目均签 NDA 与 SOW
3–7 天交付
验收通过后才付款
仅在授权范围内作业

获取报价

Crediamigo 数据 API

应用截图

API 端点一览

客户身份认证

借款人档案

信贷额度

贷款试算

预审批贷款方案

签订贷款合同

分期还款计划

分期付款单

Pix 分期还款

账户流水

Crediamigo 卡片

开放金融授权

数据类别

数据使用场景与案例

小额信贷组合监测

催收与 boleto 流程自动化

续贷与授信评估信号

开放金融数据聚合

常见问题

与 Crediamigo 相似的应用

更多信贷类应用

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

CASHe: Quick Personal Loan App

相关主题

需要集成这个 App 的数据 API？

Crediamigo 数据 API

应用截图

API 端点一览

客户身份认证

借款人档案

信贷额度

贷款试算

预审批贷款方案

签订贷款合同

分期还款计划

分期付款单

Pix 分期还款

账户流水

Crediamigo 卡片

开放金融授权

数据类别

数据使用场景与案例

小额信贷组合监测

催收与 boleto 流程自动化

续贷与授信评估信号

开放金融数据聚合

常见问题

相关应用

与 Crediamigo 相似的应用

更多信贷类应用

Bright: Loans & Credit Builder

Brigit: Cash Advance & Credit

Cairin: Pinjaman Daring Cepat

CASHe: Quick Personal Loan App

相关主题

需要集成这个 App 的数据 API？