PUBLIC SERVICES [PROD]
  1. Data Integration
PUBLIC SERVICES [PROD]
  • Introduction
  • Document Management
  • External Integration
  • Authentication
    • Generate a token to access ROIT APIs
      POST
  • Invoice-to-Pay
    • Documents Manager
      • Create document export request
      • Get export request by id
      • Delete export request by id
      • Generate signed URLs for export files by id
    • External System Integration
      • Register delivery integration
      • Get pending entities to be integrated
      • Update integration status
      • Get all documents attached to a request
      • Reprocess a specific request
    • Upload Document
      • Upload document as base64
  • Tax Reform
    • Data Integration
      • Create a new request
        GET
      • Update request status
        POST
      • List requests
        GET
      • Get request by ID
        GET
      • List Requests
        GET
      • Update request by ID
        PUT
      • Delete request by ID
        DELETE
      • Generate signed URL
        POST
      • Process callback
        POST
  1. Data Integration

Create a new request

HOM
https://hom.roit.ai
HOM
https://hom.roit.ai
GET
/roit-data-integration/v1/requests/create
Creates a new request for document processing

Request

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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://hom.roit.ai/roit-data-integration/v1/requests/create' \
--header 'Authorization;'

Responses

🟢200OK
application/json
Request created 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
optional
Status of the request
Allowed values:
PENDINGSTARTPROCESSINGAUDITCONSOLIDATIONFINISHEDFAILED
Default:
PENDING
createdAt
string 
Createdat
required
Date and time the request was created
error
object 
Error
optional
Error
status
string 
Status
optional
Default:
success
Example
{
    "status": "success",
    "message": "Request created successfully",
    "data": {
        "processUniqueId": "bb0c892a-9695-414d-966b-c3cd66959067",
        "processStatus": "PENDING",
        "createdAt": "2024-01-15T10:30:00Z"
    }
}
🟠400Bad Request
🔴500Server Error
Modified at 2025-07-15 18:38:21
Previous
Upload document as base64
Next
Update request status
Built with