Update Tracking Status

This endpoint allows you to set the tracking status of a document to "resolved". Useful when using the "resolved" option in the Get Tracking API call.

POST Parameters

Parameter	Required	Value	Description
`api_key`	✅	`{key}`	An API key that has access to the resource you want to query for
`input_id`	✅	`{integer}`	The input ID of the document you want to update the status for

Tracking Status Update: This endpoint sets the tracking status of a document to "resolved", which can be used with the "resolved" filter in the Get Tracking API call.

Code Examples

The cURL, PHP, Python, Node.js, and C# examples call Xtracta from a trusted server. The React example calls an application-defined backend proxy so the API key is never exposed in browser code.

Store XTRACTA_API_KEY as a server-side environment variable. Never embed it in browser-delivered code.

curl --request POST 'https://api-app.xtracta.com/v1/tracking/resolve' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'api_key=<API_KEY>' \
  --data-urlencode 'input_id=<INPUT_ID>'

Sample Request

POST https://api-app.xtracta.com/v1/tracking/resolve HTTP/1.1
api_key=123&input_id=456789

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<tracking_response>
    <status>200</status>
    <message>The request has been successfully processed</message>
    <input_id>1425900862</input_id>
</tracking_response>

Schema Definition

Response Elements

Element	Description
`<status>`	A status code in response to the operation.
`<message>`	Additional information about the operation – human readable.
`<input_id>`	The input id used in the call.

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">

  <xs:simpleType name="ConfidenceType">
    <xs:union>
      <xs:simpleType>
        <xs:restriction base="xs:integer">
          <xs:minInclusive value="0"/>
          <xs:maxInclusive value="100"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value=""/>
        </xs:restriction>
      </xs:simpleType>
    </xs:union>
  </xs:simpleType>

  <xs:complexType name="TrackingresponseType">
    <xs:sequence>
      <xs:element name="status" type="xs:integer" minOccurs="0"/>
      <xs:element name="message" type="xs:string" minOccurs="0"/>
      <xs:element name="input_id" type="xs:integer" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="tracking_response">
    <xs:complexType>
      <xs:sequence>
      <xs:element name="status" type="xs:integer" minOccurs="0"/>
      <xs:element name="message" type="xs:string" minOccurs="0"/>
      <xs:element name="input_id" type="xs:integer" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>

Error Responses

For JSON and XML responses generated by this endpoint, the response is wrapped in tracking_response and includes the HTTP status code and a message.

Status	Message	Description
`400`	input_id is required	Supply the tracking input ID to resolve.
`400`	input_id must be natural number	Use a positive integer input ID.
`404`	No such input found(...)	Check the input ID and API-key access.
`202`	Tracking status is not updated	The request was accepted, but no eligible error record changed. Check whether the input is already resolved.
`500`	Internal server error occurred. Please try again later or contact support@xtracta.com	Retry and contact support with the input ID and request timestamp if it persists.

Authentication, permission, IP-access-control, and rate-limit failures can be returned before this endpoint processes the request. Confirm the API key and caller access first.