Executar Movimentação de Beneficiário
/beneficiarios/movimentacaoRota única que orquestra as ações cadastrais dependendo do tipo de movimento informado na base do payload.
Request Body
application/jsonrequired
CNPJ da Operadora de saúde de destino.
Tipo de movimentação principal executada na requisição Base. * `I` - Inclusão (Requer preencher o array `inclusao`) * `A` - Alteração (Requer preencher o objeto `alteracao`) * `E` - Exclusão (Requer preencher o objeto `exclusao`) * `T` - Troca de Plano (Requer preencher o array `trocaPlano`) * `R` - Reativação (Requer preencher o array `reativacao`) * `C` - Consulta (Requer preencher o objeto `consulta`)
enum: I | A | E | T | R | C
Usuário de autenticação na API da Operadora.
Senha de autenticação na API da Operadora.
Código de origem da transação. * `0` - Origem padrão (Protheus / sistema legível do cliente). * `1` - Outra origem (RPA / integração interna).
enum: 0 | 1
Campo para uso do cliente. Sem efeito operacional no orquestrador.
Identificador para uso do cliente. Sem efeito operacional no orquestrador.
Preenchido se `movimento` for `I`. Array de novos beneficiários para inclusão.
items
Deve possuir o mesmo movimento da requisição Base (`I`).
enum: I
Grau de Parentesco padrão Protheus: * `0` - Titular (Usado pelo Bradesco para cindir titular de dependentes). * `1` - Cônjuge / Companheiro(a) (Unimed converte para Esposa se `sexo=F` ou Marido se `sexo=M`). * `2` - Filho(a) (Unimed mapeia para Filha se `sexo=F` ou Filho se `sexo=M`). * Outros valores numéricos estruturados são repassados de forma direta.
Estado civil do beneficiário: * `S` ou `1` - Solteiro * `C` ou `2` - Casado * `V` ou `3` - Viúvo * Outros caracteres (ex: D, U) - Mapeados como '4' no padrão Bradesco.
Sexo Biológico: * `M` - Masculino (Bradesco converte para '1') * `F` - Feminino (Bradesco converte para '2')
enum: M | F
Código IBGE do município do endereço.
Código IBGE do município de nascimento.
Região geográfica mapeada. Ex. SE (Sudeste).
Código de compensação BACEN do Banco (Ex. 237 = Bradesco).
Tipo de conta bancária. * `ContaPoupanca` - Saída Convertida p/ Bradesco: '2' * Qualquer outro valor - Saída Convertida p/ Bradesco: '0' (Conta Corrente)
Número completo (Conta + Dígito) formatado.
Código identificador do plano corporativo contratado.
Cartão Nacional de Saúde (SUS).
enum: S | N
enum: S | N
Mapeamento de regiões (N, NE, S, SE, CO).
Código de Dependência calculado automaticamente pela Unimed: * `00` - Titular * `01` - Esposa * `09` - Marido * `10..29` - Filhos * `30..49` - Filhas
enum: SAUDE | ODONTO
Preenchido se `movimento` for `A`. Objeto com as modificações cadastrais do beneficiário.
enum: A
enum: M | F
enum: ATIVA | INATIVA
Código IBGE do município do endereço.
Código IBGE do município de nascimento.
Região geográfica mapeada. Ex. SE (Sudeste).
Código de compensação BACEN do Banco (Ex. 237 = Bradesco).
Tipo de conta bancária. * `ContaPoupanca` - Saída Convertida p/ Bradesco: '2' * Qualquer outro valor - Saída Convertida p/ Bradesco: '0' (Conta Corrente)
Número completo (Conta + Dígito) formatado.
enum: S | N
enum: S | N
Preenchido se `movimento` for `E`. Objeto contendo os dados de cancelamento/desligamento.
Código ANS padrão para o motivo de exclusão: * `01` - Óbito * `02` - Exoneração * `03` - Aposentadoria * `04` - Cancelamento por inadimplência * `05` - Solicitação do beneficiário * `06` - Demissão * `07` - Perda de vínculo * `99` - Outros
enum: 01 | 02 | 03 | 04 | 05 | 06 | 07 | 99
enum: SAUDE | ODONTO
enum: E
enum: M | F
enum: S | N
enum: S | N
Preenchido se `movimento` for `T`. Contém dados da troca de plano.
items
enum: T
enum: M | F
Código identificador do plano corporativo contratado.
Preenchido se `movimento` for `R`. Contém chaves e datas de reativação.
items
enum: R
Preenchido se `movimento` for `C`. Parametros de filtragem para listagem ou busca do beneficiário.
Ver schema bruto / exemplo JSON
{
"cnpjProvedor": "99999999999999",
"movimento": "I",
"login": "MT9999999",
"senha": "********",
"origem": 0,
"guidProdutoBeneficiario": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
"guidFilaDeIntegracao": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"inclusao": [
{
"operacao": "I",
"nome": "Joao da Silva",
"nomeAbreviado": "JOAO SILVA",
"cpf": "99999999999",
"dataNascimento": "1985-03-12T00:00:00",
"grauParentesco": "0",
"estadoCivil": "C",
"sexo": "M",
"nomeMae": "Maria da Silva",
"rg": "123456789",
"orgaoEmissor": "SSP",
"dataExpedicaoRg": "2005-06-10T00:00:00",
"pisPasep": "12345678901",
"matriculaFuncionario": "EMP000123",
"matriculaIzii": "IZII-000123",
"dataAdesao": "2026-05-15T00:00:00",
"dataAdmissao": "2026-05-01T00:00:00",
"dataEvento": "2026-05-15T10:00:00",
"horaEvento": "10:00",
"endereco": {
"cep": "01310100",
"logradouro": "Av. Paulista",
"numero": "1000",
"complemento": "Apto 101",
"bairro": "Bela Vista",
"municipio": "Sao Paulo",
"codMunicipio": "3550308",
"codMunicipioNascimentoIbge": "3550308",
"codMunicipioNascimentoCorreio": "01000",
"uf": "SP",
"regiao": "SE"
},
"contato": {
"email": "joao.silva@acme.com.br",
"email1": "joao.pessoal@gmail.com",
"dddCelular": "11",
"dddCelular1": "11",
"dddTelefone1": "11",
"telefone1": "33334444",
"celular": "999998888",
"celular1": "988887777",
"ramalTelefone1": "1234",
"ramal": "5678"
},
"dadosBancarios": {
"banco": "237",
"agencia": "1234",
"digitoAgencia": "5",
"conta": "00012345",
"digitoConta": "6",
"tipoConta": "CC",
"numero": "00012345-6",
"tipoOperacao": "001"
},
"produto": {
"contrato": "789",
"carteirinha": "",
"subContrato": "001",
"codigo": "PLANO-ENF-01",
"codigoRDP": "RDP-001",
"dataAlteracaoPlano": null,
"dataInicioContrato": "2026-05-15T00:00:00",
"motivoAlteracao": null
},
"apolice": {
"cia": "BRADESCO",
"numero": "123456",
"subfatura": "001"
},
"altura": "175",
"cargo": "Analista de Sistemas",
"codigoAngariador": "ANG-001",
"cns": "123456789012345",
"declaracaoNascidoVivo": null,
"peso": "78",
"possuiCoberturaParcialTemporaria": "N",
"possuiContaCredito": "N",
"regiao": "SE",
"codigoSucursal": "001",
"cpdCorretor": "CPD-001",
"certificado": "CERT-123",
"dataCasamento": "2010-08-20T00:00:00",
"codTipoRegistro": "01",
"codFamilia": "FAM-001",
"codDependencia": "00",
"indLayoutOrigem": "01",
"lotacao": "Matriz SP",
"codSetor": "TI-001",
"dataLotacao": "2026-05-01T00:00:00",
"dataInicioContribuicao": "2026-05-01T00:00:00",
"situacaoEmpresa": "ATIVA",
"codigoFuncao": "FN-001",
"codPaisEmissor": "BRA",
"sequenciaFamilia": "01",
"sequenciaBeneficiario": "00",
"usuario": "integrador.izii",
"tipoProduto": "SAUDE"
}
]
}Responses
Movimentação processada ou recebida com sucesso pela fila de integração.
Ver schema bruto / exemplo JSON
{
"type": "object",
"properties": {
"sucesso": {
"type": "boolean",
"example": true
},
"mensagem": {
"type": "string",
"example": "Movimentação registrada com sucesso sob a transação guid."
},
"guidProcessamento": {
"type": "string",
"format": "uuid",
"example": "c9a8b7c6-d5e4-4321-f0ed-ba9876543210"
}
}
}Erro na requisição (validação de schema ou inconsistência de regras de negócio).
Erro interno no Orquestrador ou indisponibilidade da operadora de saúde.
Executar Movimentação de Beneficiário
/beneficiarios/movimentacaoRota única que orquestra as ações cadastrais dependendo do tipo de movimento informado na base do payload.
Request Body
application/jsonrequired
CNPJ da Operadora de saúde de destino.
Tipo de movimentação principal executada na requisição Base. * `I` - Inclusão (Requer preencher o array `inclusao`) * `A` - Alteração (Requer preencher o objeto `alteracao`) * `E` - Exclusão (Requer preencher o objeto `exclusao`) * `T` - Troca de Plano (Requer preencher o array `trocaPlano`) * `R` - Reativação (Requer preencher o array `reativacao`) * `C` - Consulta (Requer preencher o objeto `consulta`)
enum: I | A | E | T | R | C
Usuário de autenticação na API da Operadora.
Senha de autenticação na API da Operadora.
Código de origem da transação. * `0` - Origem padrão (Protheus / sistema legível do cliente). * `1` - Outra origem (RPA / integração interna).
enum: 0 | 1
Campo para uso do cliente. Sem efeito operacional no orquestrador.
Identificador para uso do cliente. Sem efeito operacional no orquestrador.
Preenchido se `movimento` for `I`. Array de novos beneficiários para inclusão.
items
Deve possuir o mesmo movimento da requisição Base (`I`).
enum: I
Grau de Parentesco padrão Protheus: * `0` - Titular (Usado pelo Bradesco para cindir titular de dependentes). * `1` - Cônjuge / Companheiro(a) (Unimed converte para Esposa se `sexo=F` ou Marido se `sexo=M`). * `2` - Filho(a) (Unimed mapeia para Filha se `sexo=F` ou Filho se `sexo=M`). * Outros valores numéricos estruturados são repassados de forma direta.
Estado civil do beneficiário: * `S` ou `1` - Solteiro * `C` ou `2` - Casado * `V` ou `3` - Viúvo * Outros caracteres (ex: D, U) - Mapeados como '4' no padrão Bradesco.
Sexo Biológico: * `M` - Masculino (Bradesco converte para '1') * `F` - Feminino (Bradesco converte para '2')
enum: M | F
Código IBGE do município do endereço.
Código IBGE do município de nascimento.
Região geográfica mapeada. Ex. SE (Sudeste).
Código de compensação BACEN do Banco (Ex. 237 = Bradesco).
Tipo de conta bancária. * `ContaPoupanca` - Saída Convertida p/ Bradesco: '2' * Qualquer outro valor - Saída Convertida p/ Bradesco: '0' (Conta Corrente)
Número completo (Conta + Dígito) formatado.
Código identificador do plano corporativo contratado.
Cartão Nacional de Saúde (SUS).
enum: S | N
enum: S | N
Mapeamento de regiões (N, NE, S, SE, CO).
Código de Dependência calculado automaticamente pela Unimed: * `00` - Titular * `01` - Esposa * `09` - Marido * `10..29` - Filhos * `30..49` - Filhas
enum: SAUDE | ODONTO
Preenchido se `movimento` for `A`. Objeto com as modificações cadastrais do beneficiário.
enum: A
enum: M | F
enum: ATIVA | INATIVA
Código IBGE do município do endereço.
Código IBGE do município de nascimento.
Região geográfica mapeada. Ex. SE (Sudeste).
Código de compensação BACEN do Banco (Ex. 237 = Bradesco).
Tipo de conta bancária. * `ContaPoupanca` - Saída Convertida p/ Bradesco: '2' * Qualquer outro valor - Saída Convertida p/ Bradesco: '0' (Conta Corrente)
Número completo (Conta + Dígito) formatado.
enum: S | N
enum: S | N
Preenchido se `movimento` for `E`. Objeto contendo os dados de cancelamento/desligamento.
Código ANS padrão para o motivo de exclusão: * `01` - Óbito * `02` - Exoneração * `03` - Aposentadoria * `04` - Cancelamento por inadimplência * `05` - Solicitação do beneficiário * `06` - Demissão * `07` - Perda de vínculo * `99` - Outros
enum: 01 | 02 | 03 | 04 | 05 | 06 | 07 | 99
enum: SAUDE | ODONTO
enum: E
enum: M | F
enum: S | N
enum: S | N
Preenchido se `movimento` for `T`. Contém dados da troca de plano.
items
enum: T
enum: M | F
Código identificador do plano corporativo contratado.
Preenchido se `movimento` for `R`. Contém chaves e datas de reativação.
items
enum: R
Preenchido se `movimento` for `C`. Parametros de filtragem para listagem ou busca do beneficiário.
Ver schema bruto / exemplo JSON
{
"cnpjProvedor": "99999999999999",
"movimento": "I",
"login": "MT9999999",
"senha": "********",
"origem": 0,
"guidProdutoBeneficiario": "a1b2c3d4-e5f6-7890-abcd-1234567890ab",
"guidFilaDeIntegracao": "f0e9d8c7-b6a5-4321-fedc-ba9876543210",
"inclusao": [
{
"operacao": "I",
"nome": "Joao da Silva",
"nomeAbreviado": "JOAO SILVA",
"cpf": "99999999999",
"dataNascimento": "1985-03-12T00:00:00",
"grauParentesco": "0",
"estadoCivil": "C",
"sexo": "M",
"nomeMae": "Maria da Silva",
"rg": "123456789",
"orgaoEmissor": "SSP",
"dataExpedicaoRg": "2005-06-10T00:00:00",
"pisPasep": "12345678901",
"matriculaFuncionario": "EMP000123",
"matriculaIzii": "IZII-000123",
"dataAdesao": "2026-05-15T00:00:00",
"dataAdmissao": "2026-05-01T00:00:00",
"dataEvento": "2026-05-15T10:00:00",
"horaEvento": "10:00",
"endereco": {
"cep": "01310100",
"logradouro": "Av. Paulista",
"numero": "1000",
"complemento": "Apto 101",
"bairro": "Bela Vista",
"municipio": "Sao Paulo",
"codMunicipio": "3550308",
"codMunicipioNascimentoIbge": "3550308",
"codMunicipioNascimentoCorreio": "01000",
"uf": "SP",
"regiao": "SE"
},
"contato": {
"email": "joao.silva@acme.com.br",
"email1": "joao.pessoal@gmail.com",
"dddCelular": "11",
"dddCelular1": "11",
"dddTelefone1": "11",
"telefone1": "33334444",
"celular": "999998888",
"celular1": "988887777",
"ramalTelefone1": "1234",
"ramal": "5678"
},
"dadosBancarios": {
"banco": "237",
"agencia": "1234",
"digitoAgencia": "5",
"conta": "00012345",
"digitoConta": "6",
"tipoConta": "CC",
"numero": "00012345-6",
"tipoOperacao": "001"
},
"produto": {
"contrato": "789",
"carteirinha": "",
"subContrato": "001",
"codigo": "PLANO-ENF-01",
"codigoRDP": "RDP-001",
"dataAlteracaoPlano": null,
"dataInicioContrato": "2026-05-15T00:00:00",
"motivoAlteracao": null
},
"apolice": {
"cia": "BRADESCO",
"numero": "123456",
"subfatura": "001"
},
"altura": "175",
"cargo": "Analista de Sistemas",
"codigoAngariador": "ANG-001",
"cns": "123456789012345",
"declaracaoNascidoVivo": null,
"peso": "78",
"possuiCoberturaParcialTemporaria": "N",
"possuiContaCredito": "N",
"regiao": "SE",
"codigoSucursal": "001",
"cpdCorretor": "CPD-001",
"certificado": "CERT-123",
"dataCasamento": "2010-08-20T00:00:00",
"codTipoRegistro": "01",
"codFamilia": "FAM-001",
"codDependencia": "00",
"indLayoutOrigem": "01",
"lotacao": "Matriz SP",
"codSetor": "TI-001",
"dataLotacao": "2026-05-01T00:00:00",
"dataInicioContribuicao": "2026-05-01T00:00:00",
"situacaoEmpresa": "ATIVA",
"codigoFuncao": "FN-001",
"codPaisEmissor": "BRA",
"sequenciaFamilia": "01",
"sequenciaBeneficiario": "00",
"usuario": "integrador.izii",
"tipoProduto": "SAUDE"
}
]
}Responses
Movimentação processada ou recebida com sucesso pela fila de integração.
Ver schema bruto / exemplo JSON
{
"type": "object",
"properties": {
"sucesso": {
"type": "boolean",
"example": true
},
"mensagem": {
"type": "string",
"example": "Movimentação registrada com sucesso sob a transação guid."
},
"guidProcessamento": {
"type": "string",
"format": "uuid",
"example": "c9a8b7c6-d5e4-4321-f0ed-ba9876543210"
}
}
}Erro na requisição (validação de schema ou inconsistência de regras de negócio).
Erro interno no Orquestrador ou indisponibilidade da operadora de saúde.