Contas e Subcontas

Criar Proposta PJ

POST/v1/proposals

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

Autenticação

bearerAuthorizationstring · header · obrigatório

Envie no header:

Authorization: Bearer {{token}}

Envia ou atualiza o formulário de abertura de conta para pessoa jurídica, incluindo dados da empresa e sócios.

Criar/atualizar proposta (Pessoa Jurídica)

documentNumber com 14 dígitos determina PJ. Exige ao menos um sócio em owner[].

Campo	Obrig.	Tipo	Descrição
`documentNumber`	✅	string	CNPJ 14 dígitos
`businessName`	✅	string	Razão social
`tradingName`	✅	string	Nome fantasia
`businessEmail`	✅	string	email
`contactNumber`	✅	string	E.164
`companyType`	❌	string	`PJ` `MEI` `ME`
`businessAddress`	✅	object	Endereço da empresa
`financialCompanyDetails.declaredCompanyRevenue`	✅*	string	Faturamento mensal
`owner[]`	✅	array	min 1 sócio
`owner[].ownerType`	✅	string	`REPRESENTANTE` `SOCIO` `DEMAIS SOCIOS`

Body

application/json

Content-Type:application/json

{
  "documentNumber": "12345678000195",
  "businessName": "Empresa LTDA",
  "tradingName": "Empresa",
  "businessEmail": "contato@empresa.com",
  "contactNumber": "+5511999998888",
  "companyType": "PJ",
  "businessAddress": {
    "postalCode": "01310100",
    "street": "Av. Paulista",
    "number": "1000",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "addressComplement": null
  },
  "financialCompanyDetails": {
    "declaredCompanyRevenue": "100000.00"
  },
  "owner": [
    {
      "ownerType": "REPRESENTANTE",
      "documentNumber": "12345678901",
      "fullName": "João da Silva",
      "phoneNumber": "+5511999998888",
      "email": "joao@empresa.com",
      "motherName": "Maria da Silva",
      "birthDate": "1980-05-20",
      "isPoliticallyExposedPerson": false,
      "address": {
        "postalCode": "01310100",
        "street": "Av. Paulista",
        "number": "200",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP"
      },
      "financialOwnerDetails": {
        "ownerDeclaredIncome": "10000.00"
      }
    }
  ],
  "webhookUrl": "https://meusite.com/webhook"
}

Schema

Field	Type	Required	Description
documentNumber	string	-	-
businessName	string	-	-
tradingName	string	-	-
businessEmail	string	-	-
contactNumber	string	-	-
companyType	string	-	-
businessAddress	object	-	-
financialCompanyDetails	object	-	Ver referência
owner[1]	array	-	-
webhookUrl	string	-	-

Headers

Name	Type	Value	Required
Content-Type	-	application/json	Optional

← Anterior

Criar Proposta PF

Buscar Proposta

const url = 'https://sandbox.validapay.com.br/v1/proposals';

const options = {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "documentNumber": "12345678000195",
  "businessName": "Empresa LTDA",
  "tradingName": "Empresa",
  "businessEmail": "contato@empresa.com",
  "contactNumber": "+5511999998888",
  "companyType": "PJ",
  "businessAddress": {
    "postalCode": "01310100",
    "street": "Av. Paulista",
    "number": "1000",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "addressComplement": null
  },
  "financialCompanyDetails": {
    "declaredCompanyRevenue": "100000.00"
  },
  "owner": [
    {
      "ownerType": "REPRESENTANTE",
      "documentNumber": "12345678901",
      "fullName": "João da Silva",
      "phoneNumber": "+5511999998888",
      "email": "joao@empresa.com",
      "motherName": "Maria da Silva",
      "birthDate": "1980-05-20",
      "isPoliticallyExposedPerson": false,
      "address": {
        "postalCode": "01310100",
        "street": "Av. Paulista",
        "number": "200",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP"
      },
      "financialOwnerDetails": {
        "ownerDeclaredIncome": "10000.00"
      }
    }
  ],
  "webhookUrl": "https://meusite.com/webhook"
})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200 FINISHED

{
  "status": "FINISHED",
  "formId": "form_xxx",
  "sendStatus": "SENT",
  "proposalId": "prop_xxx"
}

← Anterior

Criar Proposta PF

Buscar Proposta