--- title: "Nursing professional registration lookup (MG) — Conselho Regional de Enfermagem (COREN-MG)" method: POST path: "/br/coren/mg/consulta-profissionais" tags: ["Exato - Conselhos Profissionais"] --- # Nursing professional registration lookup (MG) — Conselho Regional de Enfermagem (COREN-MG) `POST /br/coren/mg/consulta-profissionais` ## Request - Base URL: `https://api.directdigital.com.br` - URL: `https://api.directdigital.com.br/br/coren/mg/consulta-profissionais` - Auth: API key in header `token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Searches the nursing registry of the state in the route by name, CPF or registration number and returns each professional's registration status. **Source:** public professional search of the Regional Nursing Council (COREN) of that state, or the national nursing registry of the Conselho Federal de Enfermagem (COFEN), queried at the time of the request. **Returns:** `Total` and, in `Profissionais`, each professional found: registration number, name, professional category, registration status and type, regional council and state. **Execution:** synchronous; no PDF. **Note:** - Send at least one of `nome`, `cpf` or `numero`. - Same search as `/br/coren/consulta-profissionais` with `uf`. ## Query parameters - `test_mode` boolean - `lightweight` boolean ## Request body `application/x-www-form-urlencoded` - object - `nome` string: Professional's name. One of `nome`, `cpf` or `numero`. - `cpf` string: Professional's CPF, digits only. E.g.: 12345678909. One of `nome`, `cpf` or `numero`. - `numero` string: COREN registration number. One of `nome`, `cpf` or `numero`. ## Response `200` Success - CorenConsultaProfissionaisResponse: CorenConsultaProfissionaisResponse - `ApiResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInput' | 'DataUnavailable' | 'NotFound' | 'InvalidParameters' | 'UnsupportedCombination' | 'RemoteUnavailable' | 'Timeout' | 'RetryLimitReached' | 'RemoteError' | 'InProgress' | 'InsufficientCredits' | 'ConcurrentLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'Created' | 'Updated' | 'Deleted' | 'InternalError' | 'ValidationFailed' | 'Conflict' | 'ResourceLocked' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Cancelled' | 'Paused' | 'Resumed': New unified result type for queries and administrative operations. Replaces TransactionResultType with better semantics. - `BalanceInBrl` number, double: Current balance in BRL. - `BalanceInCredits` integer: Current balance in credits. - `DataSourceCategory` string: Data source category - `Date` string, date-time: Transaction date. - `ElapsedTimeInMilliseconds` integer: Execution time (in milliseconds). - `ExecutedDataSourceName` string: Display name of the query type that actually ran. - `ExecutedDataSourceTypeId` integer: Id of the query type that actually ran (the one recorded on the transaction), which may differ from the requested type when the route is generic per state or when a master delegates to a sub-query. - `HasOriginalFiles` boolean: Indicates that the transaction carries original files from the source (the issued certificate, for example) for download at OriginalFilesUrl. False does not mean the URL does not exist: it is always built. - `HasPdf` boolean: Indicates that there is a PDF proof document for the result. - `Message` string: Message. - `OriginalFilesUrl` string: URL to download the transaction's original files (when available). - `OutdatedResult` boolean: Indicates that the result is dated. - `PdfUrl` string: URL to download the transaction's PDF proof document (when available). - `ResultSubtype` string: Specific result subtype to provide additional context (e.g.: 'duplicate_name', 'invalid_cpf'). - `ResultTypeCode` integer: Numeric result code (compatible with TransactionResultTypeCode but extensible). - `TotalCost` number, double: Internal use only. - `TotalCostInCredits` integer: Total transaction cost in credits. - `TransactionResultType` 'Success' | 'SuccessWithRemarks' | 'InvalidInputData' | 'UnavailableData' | 'EntityNotFound' | 'InvalidParameters' | 'ParametersNotSupported' | 'RemoteSystemUnavailable' | 'Timeout' | 'AttemptsLimitReached' | 'RemoteSystemError' | 'AsyncExecutionInProgress' | 'AwaitingExecution' | 'BirthDateRequired' | 'InsufficientBalance' | 'SimultaneousTransactionsLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'InternalError':
TransactionResultType CodeTransactionResultTypeFinalBillableError
1SuccessTrueTrueFalse
2Partial success or success with remarksTrueTrueFalse
3Invalid input or documentTrueFalseTrue
4Data not availableTrue (for the day)FalseFalse
5Entity or document nonexistent/not foundTrueTrueFalse
6Invalid input parametersTrueFalseTrue
7Unsupported parameter combinationTrueFalseTrue
8Data source or remote system unavailableFalseFalseTrue
9Time limit exceededFalseFalseTrue
10Attempts limit reachedFalseFalseTrue
11Error in the data source or remote systemFalseFalseTrue
12Transaction in progressFalseFalseFalse
101Insufficient credit balance, please contact usFalseFalseTrue
102Simultaneous transactions limit reached, please contact usFalseFalseTrue
103Transaction not available, please contact usFalseFalseTrue
104Invalid credentials or access denied, please contact usFalseFalseTrue
105Transaction cancelled, please contact usFalseFalseTrue
255*Unexpected internal error, please contact usTrue (for the day)FalseTrue
* Query under maintenance, try again later or contact Exato to report the problem
- `TransactionResultTypeCode` integer: Transaction result type code. - `UniqueIdentifier` string: Unique transaction identifier. Store it for control and debugging. - `Result` CorenConsultaProfissionaisResult: CorenConsultaProfissionaisResult - `Total` integer: Number of professionals found. - `Profissionais` CorenProfissionalItem[]: Professionals found, one entry per registration. - `NumeroInscricao` string: COREN registration number. - `Nome` string: Professional's name. - `Categoria` string: Professional category, as published by the council (e.g. nurse, nursing technician). - `Situacao` string: Registration status, as published by the council. - `TipoInscricao` string: Registration type, as published by the council. - `Coren` string: Regional council of the registration (e.g. COREN-SP). - `Uf` string: State of the registration. --- [API](https://skmtc.dev/directdigital/apis/directdigital.md) - [All operations](https://skmtc.dev/directdigital/apis/directdigital/llms.txt) - [OpenAPI document](https://skmtc.dev/directdigital/apis/directdigital/revisions/3b7fd216787b?raw)