Para programadores dos empregadores
API do Perfil Verificado
Consulte o Perfil Verificado Stodacom de um candidato -- ou a empresa verificada de um fornecedor -- a partir do seu sistema de RH, compras ou recrutamento. Recebe os mesmos factos da página em linha, em JSON: o estado de cada item, o que foi verificado, como, quando e o ID de auditoria.
Como funciona
- O candidato dá-lhe o seu código de partilha (ex.
VP-7K3F-9Q2M-XP), a partir do CV, do certificado ou da ligação. O código é o seu consentimento: só pode ler perfis cujo titular lhe deu o código, enquanto a ligação estiver ativa. - Cada consulta aparece no registo de acessos do candidato com o nome da sua organização.
- Números de identificação, datas de nascimento, moradas e contactos nunca são devolvidos.
Autenticação
Envie a sua chave de API no cabeçalho X-API-Key. As chaves são emitidas pela Stodacom para contas de cliente -- contacte-nos para obter uma. Mantenha-a secreta e no servidor; nunca a coloque num navegador ou aplicação móvel.
Consultar um perfil
GET https://stodacomdesktop.com/api/v1/verified_profile?code=VP-XXXX-XXXX-XX
| Parâmetro | Descrição |
|---|---|
code | Obrigatório. O código de partilha. Maiúsculas, espaços e hífenes não importam. |
include_photo | Opcional, 1 para incluir a fotografia verificada em JPEG base64 (só quando a identidade é partilhada e a fotografia verificada). |
curl -H "X-API-Key: YOUR_KEY" \ "https://stodacomdesktop.com/api/v1/verified_profile?code=VP-7K3F-9Q2M-XP"
Resposta:
{
"success": true,
"profile": {
"name": "Jane Achieng",
"name_verified": true,
"photo_verified": true,
"overall_status": "partially_verified",
"verified_count": 2,
"total_count": 3,
"share_code": "VP-7K3F-9Q2M-XP",
"link_expires_at": "2026-10-27T13:10:49+03:00",
"checked_at": "2026-09-27T13:10:49+03:00",
"check_url": "https://stodacomdesktop.com/verified_profile_check?code=VP-7K3F-9Q2M-XP",
"items": [
{
"type": "identity",
"label": "Identity",
"status": "verified",
"details": [{"label": "Name on ID", "value": "Jane Achieng"}],
"verification": {
"method": "National ID Database Check",
"verified_at": "2026-09-13T16:33:18+03:00",
"valid_until": "2027-09-13T16:33:18+03:00",
"audit_id": "STV-000144"
}
}
]
}
}
Estados
status do item | Significado |
|---|---|
verified | Verificado pela Stodacom e dentro do prazo de validade. |
needs_review | Foi verificado, mas a reverificação está devida ou em curso. |
discrepancy | As nossas verificações encontraram algo que não corresponde. Não confie nisso. |
rejected | Revisto e não foi possível verificar. |
not_verified | Nunca verificado, ou a verificação caducou. |
overall_status é um de fully_verified, partially_verified, in_progress, issue (uma divergência) ou pending.
Consultar uma empresa
Uma empresa com quem trabalha dá-lhe o seu código de partilha (ex. VB-7K3F-9Q2M-XP), a partir da página da ligação ou do certificado. Tal como nos perfis, o código é o seu consentimento, cada consulta aparece no seu registo com o nome da sua organização, e as consultas são contadas e cobradas da mesma forma. Documentos, números de identificação, datas de nascimento e contactos das pessoas nunca são devolvidos.
GET https://stodacomdesktop.com/api/v1/verified_business?code=VB-XXXX-XXXX-XX
curl -H "X-API-Key: YOUR_KEY" \ "https://stodacomdesktop.com/api/v1/verified_business?code=VB-7K3F-9Q2M-XP"
Resposta:
{
"success": true,
"business": {
"legal_name": "Kigali Fresh Produce Ltd",
"trading_name": "KFP",
"registration_number": "108766432",
"country": "Rwanda",
"legal_form": "Limited Liability Company",
"incorporation_date": "2019-03-04",
"registry_status": "Active / registered",
"trust_level": "verified",
"items": [
{
"item": "registration",
"label": "Registration",
"status": "verified",
"verified_on": "2026-10-25",
"valid_until": "2027-10-25",
"audit_id": "STB-000104",
"change_under_review_since": null
}
],
"directors": [{"name": "Aline Uwase", "role": "Managing director"}],
"owners": [{"name": "Aline Uwase", "type": "individual", "effective_percent": 60,
"held": "direct", "owners_not_traced": null}],
"address": {"registered": "KG 11 Ave, Kigali", "trading": null},
"licences": [],
"screening": {"last_screened_on": "2026-10-26", "confirmed_matches": []},
"share_code": "VB-7K3F-9Q2M-XP",
"link_expires_at": "2027-01-23",
"checked_at": "2026-10-26T09:00:00+03:00"
}
}
| Campo | Significado |
|---|---|
trust_level | unverified (nada verificado ainda), registered (registo verificado), verified (também representante, administradores e proprietários) ou verified_plus (também endereço e licenças). |
items[].status | verified, expired (passaram os 12 meses) ou not_verified. |
change_under_review_since | A empresa comunicou uma alteração nesta data, que está a ser verificada; a verificação mostrada mantém-se em vigor até lá. |
owners | Empresas proprietárias e pessoas que detêm efetivamente 10% ou mais, através de quaisquer empresas intermédias. owners_not_traced indica porque não foram identificados os donos de uma empresa (por exemplo, cotada em bolsa). |
screening | A empresa, os administradores e os proprietários são verificados diariamente em listas de sanções, exclusões e pessoas politicamente expostas. confirmed_matches lista as correspondências confirmadas pela nossa equipa, com os respetivos indicadores. |
Erros e limites
| HTTP | Quando |
|---|---|
| 400 | Nenhum code indicado. |
| 401 | Chave de API em falta, inválida ou desativada. |
| 404 | Nenhum perfil ou empresa ativo para esse código -- mal escrito, expirado ou revogado. Trate como não verificado. |
| 402 | As consultas grátis do mês acabaram e a sua carteira pré-paga não cobre a próxima. Carregue para continuar. |
| 429 | Limite de pedidos: a quota por minuto da sua chave (120 por omissão) ou 120 por minuto por endereço IP. |
Preços: as primeiras 100 consultas bem-sucedidas de cada mês são grátis, depois $0.25 cada -- da sua carteira, ou no extrato mensal para contas faturadas. As consultas que devolvem 404 não contam.
Os resultados são atuais no momento do pedido; guarde checked_at com o que guardar e consulte de novo antes de confiar num resultado antigo.
