Beneficiary

Rota responsável por cadastrar um beneficiário por cliente e solicitação

SecurityoAuth2ClientCredentials

Request

path Parameters

userId required	string or null
solicitationId required	integer <int32>

Request Body schema:
application/json-patch+json

name required	string
cpf required	string
rg required	string
relationship required	string
phoneNumber required	string
required	object (CreateAddressForBeneficiaryRequest)

Responses

200

Add a new beneficiary per client and solicitation

400

Unable to add a new beneficiary per client and solicitation due to validation error

post/api/v1/users/{userId}/solicitations/{solicitationId}/beneficiaries

Request samples

Payload

{"name": "Paulo Magno Alves da Rocha",
"cpf": "534.234.867-34",
"rg": "2991396",
"relationship": "Filho",
"phoneNumber": "(61) 93847-2933",
"address": {"country": "Brasil",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"zipCode": "12345-678",
"complement": "ap 9"
}
}

Response samples

application/json

[{"id": 0,
"name": "string",
"cpf": "string",
"rg": "string",
"relationship": "string",
"phoneNumber": "string",
"address": {"id": 0,
"country": "string",
"zipCode": "string",
"state": "string",
"city": "string",
"neighborhood": "string",
"street": "string",
"number": "string",
"complement": "string",
"latitude": 0,
"longitude": 0,
"propertyType": {"id": 0,
"type": "string"
}
}
}
]

➔ Next to StatusTypeReason

Beneficiary

Rota responsável por cadastrar um beneficiário por cliente e solicitação

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Request Body schema:
application/json-patch+json