Pular para o conteúdo principal

Competências

Consultar a estrutura de documentos exigida por uma competência, convidar participantes e reexecutar a validação de um split de documento.

Rotas​

método e rotao que faz
POST /v1/api/competencies/{competencyId}/send-inviteEnviar convite para participante
GET /v1/api/competencies/execute-validation-code-for-split/{splitId}Execute competency validation code for split

Enviar convite para um participante​

curl --request POST 'https://api.dynadok.com/v1/api/competencies/6500a1b2c3d4e5f600000004/send-invite' \
  --header 'x-api-key: 550e8400-e29b-41d4-a716-446655440000.SUA_CHAVE' \
  --header 'Content-Type: application/json' \
  --data '{ "participantId": "6500a1b2c3d4e5f600000002" }'
{
  "code": 200,
  "message": "OK",
  "timestamp": 1758585600000,
  "data": {
    "participantId": "6500a1b2c3d4e5f600000002",
    "success": true,
    "message": "Convite enviado com sucesso",
    "inviteSentAt": "2026-09-23T12:00:00.000Z"
  }
}

Documentos exigidos pela competência​

Para descobrir o que precisa ser enviado — e, principalmente, o identificador de cada documento solicitado —, use Consultar os documentos solicitados ao participante. É a consulta que devolve o competencyDocumentId, sem o qual não se distingue dois documentos do mesmo tipo na mesma competência.

Reexecutar a validação de um split​

GET /v1/api/competencies/execute-validation-code-for-split/{splitId} roda de novo o código de validação da competência sobre os documentos gerados por um envio de split-and-redistribute (ver Documentos), identificado por splitId. data é uma lista de resultados, cada um com seu próprio status e documents — os documentos recalculados, no mesmo formato usado nas rotas de Documentos. O acessor é data[].documents, não data.documents. Formato completo na Referência.

Erros típicos​

Ver Envelope e erros. participantId inexistente em send-invite responde 400, não 404.