18 - Salvar Sócio

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Pessoa/SalvarSocio \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{}'

200

{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Por meio deste endpoint o parceiro inclui ou atualiza um registro de sócio de um cliente específico. Para que ocorra uma atualização, é necessário o envio do campo código, preenchido com o código do registro na base da BMP, ou então a busca será através do campo DocumentoFederal.

Mostrar Tabela EstadoCivil

ID	Descrição
1	Solteiro
2	Casado
3	Desquitado
4	Divorciado
5	Separado
6	Viúvo
7	Outros
8	Não informado
9	Vínculo Conjugal

​

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

No exemplo de retorno ao lado, o campo code representa a coluna Código desta tabela; o campo context representa a coluna Código Detalhado; e o campo message representa a coluna Mensagem.

Categoria	Operação	Ação	Código	Código Detalhado	Mensagem
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	C0047	V0001	Método disponível para Pessoa Jurídica
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	C0108	V0001	Documento Federal deve ser informado
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	C0108	V0002	Cliente não encontrado com o documento {documentoCliente}
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	C0108	V0003	Cliente não cadastrado pelo parceiro de integração
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0001	CPF já cadastrado como sócio
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0002	Documento deve ser preenchido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0003	Nome deve ser preenchido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0004	CPF inválido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0005	CNPJ Inválido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0006	CEP inválido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0007	Nome do cônjuge deve ser preenchido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0008	CPF do cônjuge deve ser preenchido
Pessoa	CreateUpdatePessoaSocio	SalvarSocio	T0624	D0009	CPF do cônjuge Inválido

Autorizações

Authorization · string · header · obrigatório

Informe o token

Cabeçalhos

IdempotencyKey · string · obrigatório

Corpo

application/jsontext/jsonapplication/*+json

dto · object

Show child attributes

param · object

Show child attributes

Resposta

200

text/plain

OK

msg · string | null

hasError · boolean

messages · object[] | null

Show child attributes

codigo · string<uuid>