Cria ou executa document
POST/api/upload/partner/document
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- SuperAdmin
- Clé d’API:
- media:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Envia o documento de identidade ou o comprovante de endereço de um sócio administrador. Só owner ou admin da comunidade do `X-CommunityId` (ou SuperAdmin), e o sócio precisa pertencer ao cadastro dessa comunidade, senão 404. O arquivo é gravado privado no S3: a `url` da resposta é assinada e expira em 15 minutos.
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête multipart/form-data
| Nom | Type | Description |
|---|---|---|
documentobligatoire | string (binary) | |
partnerIdobligatoire | string (uuid) | |
documentTypeobligatoire | identity | address-proof |
Réponses
| Statut | Description |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/upload/partner/document" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-F "file=@caminho/do/arquivo"