Plantonizei

App do médico › Autocadastro

Empresa pelo código (primeira etapa do cadastro)

GET/api/v1/signup/empresas/{codigo}Pública, sem sessão

Como funciona

Primeira etapa do autocadastro: o profissional digita o código da empresa e o app confirma para onde o cadastro vai. A resposta traz o nome da empresa e, quando o código é de uma escala, a contratante e a escala.

Traz também o que a última etapa vai pedir: os documentos que a empresa exige (documents, com o tipo e se é obrigatório) e se a foto do rosto é obrigatória (faceRequired).

O código tem 8 caracteres e é conferido sem diferenciar maiúsculas. Código errado e código inexistente dão o mesmo 404. O teto é de 30 consultas por hora por endereço de origem, para ninguém adivinhar códigos por tentativa.

Parâmetros

  • codigoCaminho · string · obrigatórioCódigo da empresa, com 8 caracteres. Maiúsculas e minúsculas tanto faz.

Respostas

200 · A empresa do código, os documentos exigidos e se o rosto é obrigatório.

  • codestring · Código.
  • companystring · Empresa.
  • documentsobject[] · Documentos.
  • documents[].idstring · Identificador do registro.
  • documents[].namestring · Nome.
  • documents[].requiredboolean · É obrigatório.
  • documents[].typestring · Tipo do documento, da lista da plataforma. A identidade é conferida na hora do envio.
  • faceRequiredboolean · O cadastro pede a foto do rosto.
  • namestring · Nome.
  • schedulestring · Escala.

Corpo de exemplo

{
  "code": "7F3A9K2B",
  "company": "texto",
  "documents": [
    {
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "name": "texto",
      "required": true,
      "type": "texto"
    }
  ],
  "faceRequired": true,
  "name": "texto",
  "schedule": "texto"
}