Get request by ID - PUBLIC SERVICES [PROD]

Request

Path Params

process_unique_id

string

Process Unique Id

required

Header Params

Authorization

string

required

token generated

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Request details retrieved successfully

Body

status_code

integer

Status Code

optional

>= 200<= 599

Default:

200

message

string

Message

optional

Default:

data

object

Data

optional

Response data

processUniqueId

string

Processuniqueid

required

Unique ID of the request

processStatus

required

Status of the request

Allowed values:

PENDINGSTARTPROCESSINGAUDITCONSOLIDATIONFINISHEDFAILED

callbackUrl

string

Callbackurl

optional

Callback URL to send the result of the request

operationType

string

Operationtype

optional

Type of operation to be processed

documentType

string

Documenttype

optional

Type of document to be processed

createdAt

string

Createdat

required

Date and time the request was created

updatedAt

string

Updatedat

required

Date and time the request was updated

metadata

object

Metadata

optional

Additional metadata about the request

error

object

Error

optional

Error message

status

string

Status

optional

Default:

success

Example

{
    "status": "success",
    "message": "Request retrieved successfully",
    "data": {
        "processUniqueId": "bb0c892a-9695-414d-966b-c3cd66959067",
        "processStatus": "PROCESSING",
        "callbackUrl": "https://api.example.com/webhook/status-update",
        "operationType": "DOCUMENT_PROCESSING",
        "documentType": "NFE",
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T11:00:00Z",
        "metadata": {
            "fileName": "documento_nfe.xml",
            "fileSize": 1024000,
            "uploadedAt": "2024-01-15T10:35:00Z"
        }
    }
}

🔴500Server Error