API Usage Manual: X-OperationReference

This document provides detailed information about the X-OperationReference Header, which allows send a tracking client value to the TuIdentidad API.

Overview

The X-OperationReference header is a utility for tracking transactions, allowing for better traceability in the consumption history.

X-OperationReference Header Details

The X-OperationReference header is used in requests to the TuIdentidad's API endpoints, usually in 'GET' or 'POST' requests. This value will be included as an optional header in requests. This value facilitate to track and trace operations performed to the API.

If this Header is not provided, it does not affect the response or the TuIdentidad API functionality. Remember, use X-OperationReference Header is optional.

The Header X-OperationReference accept a 40-character alphanumeric string. It can includes uppercase and lowercase letters (A-Z, a-z), numbers (0-9), and symbols like hyphens (-) and underscores (_). Avoid spaces, line breaks, or tabs. Use UTF-8 encoding to ensure compatibility.

The X-OperationReference serves as a tracking reference generated by the client. Its format and randomness are determined solely by the client, who is responsible for ensuring its proper generation and assignment.

Example Use

For this CURL example, the request use the header X-OperationReference with the value ABC000001

curl --location 'https://dev.tuidentidad.com/api/Address/cfe \
--header 'x-Version: <string>' \
--header 'ApiKey: *****' \
--header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--header 'X-OperationReference: ABC000001 \
--form 'imageFile=@"Filetoupload.pdf'’

On this another CURL example, the request do not use the header X-OperationReference

curl --location 'https://dev.tuidentidad.com/api/Address/cfe \
--header 'x-Version: <string>' \
--header 'ApiKey: *****' \
--header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--form 'imageFile=@"Filetoupload.pdf'’

Review the X-OperationReference information

The X-OperationReference information will be write into the Consumption History Data in the Field "XOperationReference" (The field have not hyphen (-) in the name)