Skip to main content
Consulta o status dos documentos KYC (Know Your Customer) associados ao seller de uma organização. Retorna quais documentos já foram enviados e quais ainda precisam ser enviados para completar a verificação.
A verificação KYC é obrigatória para que a sub-organização possa realizar saques. Sem aprovação, os pagamentos recebidos ficam retidos.

​
Autenticação

Aceita dois tipos de autenticação:
  • JWT da própria organização — organização consultando seu próprio status
  • JWT da organização pai — organização pai consultando o status KYC de uma sub-organização filha

​
Parâmetros de Query

​
organization_id
string
required
Identificador único da organização cujo status KYC será consultado. Deve corresponder à organização do token (ou ser uma filha direta dela).

​
Resposta

​
marketplaceId
string
Identificador do marketplace no gateway de pagamento.
​
sellerId
string
Identificador do seller no gateway de pagamento.
​
documents
object
Status dos documentos KYC.
​
kyc_complete
boolean
Indica se todos os documentos necessários já foram enviados e o KYC está completo.

​
Tipos de Documentos

TipoDescrição
SELFIEFoto do rosto da pessoa (prova de vida)
CNH_FULLCNH completa (frente e verso em uma imagem ou PDF)
CNH_FRONTFrente da CNH
CNH_BACKVerso da CNH
RG_FRONTFrente do RG
RG_BACKVerso do RG
É necessário enviar SELFIE mais um conjunto completo de documento de identidade: CNH_FULL ou (CNH_FRONT + CNH_BACK) ou (RG_FRONT + RG_BACK).

​
Exemplos

​
Sub-organização consultando seu próprio KYC

curl -X GET "https://app.chargefy.io/api/v1/accounts/kyc/documents?organization_id=org_01j9abc333" \
  -H "Authorization: Bearer $SUBORG_ACCESS_TOKEN"

​
Organização pai consultando KYC de uma filha

curl -X GET "https://app.chargefy.io/api/v1/accounts/kyc/documents?organization_id=org_01j9abc333" \
  -H "Authorization: Bearer $PARENT_ACCESS_TOKEN"

​
Resposta de Exemplo

{
  "marketplaceId": "mkt_abc123",
  "sellerId": "seller_xyz456",
  "documents": {
    "uploaded": ["SELFIE"],
    "pendingUpload": ["CNH_FRONT", "CNH_BACK"]
  },
  "kyc_complete": false
}

​
Resposta quando KYC está completo

{
  "marketplaceId": "mkt_abc123",
  "sellerId": "seller_xyz456",
  "documents": {
    "uploaded": ["SELFIE", "CNH_FRONT", "CNH_BACK"],
    "pendingUpload": []
  },
  "kyc_complete": true
}

​
Erros

StatusDescrição
400organization_id não informado
401Token ausente ou inválido
403Token não pertence à organização ou à sua organização pai
404Seller não encontrado para esta organização