Skip to main content
POST
/
api
/
v1
/
customer
/
benefits
/
requests
/
{passengerBenefitRequestId}
/
documents
Add Benefit Document
curl --request POST \
  --url https://api.example.com/api/v1/customer/benefits/requests/{passengerBenefitRequestId}/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "STUDENT_ID",
  "storageKey": "benefits/0197f712/student-id.pdf",
  "fileName": "carteirinha-estudantil.pdf",
  "contentType": "application/pdf"
}
'
{
  "benefitDocumentValidationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "passengerBenefitRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "validatedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentType": "<string>",
  "storageKey": "<string>",
  "fileName": "<string>",
  "contentType": "<string>",
  "rejectionReason": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "validatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
passengerBenefitRequestId
string<uuid>
required

Passenger benefit request identifier.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Body

application/json

Benefit document payload.

​
documentType
string
required

Document type.

Example:

"STUDENT_ID"

​
storageKey
string
required

Stored file key returned by Storage API.

Example:

"benefits/0197f712/student-id.pdf"

​
fileName
string
required

Original file name.

Example:

"carteirinha-estudantil.pdf"

​
contentType
string
required

File MIME type.

Example:

"application/pdf"

Response

Created

Documento enviado e analisado para uma solicitação de benefício tarifário

​
benefitDocumentValidationId
string<uuid>
required

Identificador único

​
passengerBenefitRequestId
string<uuid>
required

Solicitação de benefício relacionada

​
customerId
string<uuid>
required

Cliente/passageiro dono do documento

​
validatedByUserId
string<uuid> | null
required

Usuário que analisou o documento

​
documentType
string
required

Tipo do documento enviado

​
storageKey
string
required

Chave do arquivo no storage

​
fileName
string
required

Nome original do arquivo

​
contentType
string
required

MIME type do arquivo

​
status
enum<string>
required

Status da validação

Available options:
PENDING,
APPROVED,
REJECTED,
EXPIRED
​
rejectionReason
string | null
required

Motivo de rejeição do documento

​
expiresAt
string<date-time> | null
required

Data de expiração do documento validado

​
validatedAt
string<date-time> | null
required

Data em que o documento foi analisado

​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

Usuário que removeu o registro, quando aplicável

​
deletedAt
string<date-time> | null
required

Data de remoção lógica