Skip to content

Cria ou executa document

POST/api/upload/business/document

Auth
Requires a token
Who can call it:
owner
admin
SuperAdmin
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Envia o documento de identidade ou o comprovante de endereço do KYC da comunidade do `X-CommunityId`. Só owner ou admin dessa comunidade (ou SuperAdmin). O `communityId` do corpo é opcional; se vier, precisa ser o do header, senão 403. O arquivo é gravado privado no S3: a `url` da resposta é assinada e expira em 15 minutos.

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body multipart/form-data

NameTypeDescription
documentrequiredstring (binary)
documentTyperequiredidentity | address-proof
communityIdoptionalstring (uuid)Opcional; precisa ser igual ao X-CommunityId

Responses

StatusDescription
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

curl example

curl -X POST "https://api.memberfy.net/api/upload/business/document" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -F "file=@caminho/do/arquivo"