Docs
post https://bank-account-validator-br.iugu.com/api/v1/validate

Criar validação de conta bancária

Cria uma nova validação de conta bancária e envia o código de verificação via PIX

Sem ações implementadas definidas

Request

Headers

workspace_id

Required

Type: string

Identificador único do workspace (UUID ou short ID)

Ex: 550e8400-e29b-41d4-a716-446655440000

Body Required

Content Type: application/json

bank

Required

String ^[0-9]{8}$

ISPB do banco (8 dígitos)

Ex: 00000000

branch

Required

String

Número da agência

Ex: 0001

account

Required

String

Número da conta

Ex: 123456

account_digit
String

Dígito verificador da conta

Ex: 7

account_type

Required

String
Enum: `0`, `1`, `2`, `3`

Tipo da conta

Ex: 0

fiscal_code

Required

String

CPF (11 dígitos) ou CNPJ (14 dígitos) do titular

Ex: 12345678900

Example
1
2
3
4
5
6
7
8
{
  "bank": "00000000",
  "branch": "0001",
  "account": "123456",
  "account_digit": "7",
  "account_type": "0",
  "fiscal_code": "12345678900"
}

Response

201

Validação criada com sucesso

id
Integer

ID único da validação

bank
String

ISPB do banco

branch
String

Número da agência

account
String

Número da conta

account_digit
String

Dígito verificador da conta

account_type
String

Tipo da conta (0=CACC, 1=SLRY, 2=SVGS, 3=TRAN)

fiscal_code
String

CPF ou CNPJ do titular

status
String
Enum: `validating`, `validated`, `invalidated`

Status da validação

error_code
String

Código do erro (vazio se não houver erro)

error_message
String

Mensagem de erro (vazio se não houver erro)

Example
1
2
3
4
5
6
7
8
9
10
11
12
{
  "id": "<ID>",
  "bank": "<BANK>",
  "branch": "<BRANCH>",
  "account": "<ACCOUNT>",
  "account_digit": "<ACCOUNT_DIGIT>",
  "account_type": "<ACCOUNT_TYPE>",
  "fiscal_code": "<FISCAL_CODE>",
  "status": "<STATUS>",
  "error_code": "<ERROR_CODE>",
  "error_message": "<ERROR_MESSAGE>"
}

400

Requisição inválida

error
String

Mensagem de erro

Example
1
2
3
{
  "error": "<ERROR>"
}

422

Entidade não processável

error_code
String

Código do erro de validação

error_message
String

Mensagem descritiva do erro

Example
1
2
3
4
{
  "error_code": "<ERROR_CODE>",
  "error_message": "<ERROR_MESSAGE>"
}