Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arcpass.vibepas.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to inspect the relay transaction associated with an approved sponsorship request. A relay transaction is created when a sponsorship moves from approved to relayed status. You can use it to track whether the on-chain transaction has been broadcast and confirmed.

​
Request

GET /relay/:id
​
id
string
required
UUID of the relay transaction record. This is distinct from the sponsorship request ID — obtain it from the relay record linked to your sponsorship.

​
Response

​
id
string
required
UUID of this relay transaction record.
​
sponsorshipRequestId
string
required
UUID of the sponsorship request that triggered this relay. Use this to correlate the relay with the originating request.
​
status
string
required
Current status of the relay transaction. See the status table below.
​
relayAttempt
integer
required
Number of times relay submission has been attempted for this record. Starts at 1 on first submission.
​
transactionHash
string
On-chain transaction hash once the transaction has been broadcast, or null if it has not been submitted yet.
​
submittedAt
string
ISO 8601 timestamp of when the transaction was first broadcast to the network, or null if not yet submitted.
​
confirmedAt
string
ISO 8601 timestamp of when the transaction was mined and confirmed, or null if not yet confirmed.
​
failedAt
string
ISO 8601 timestamp of when the relay entered a failed state, or null if it has not failed.
​
failureReason
string
Human-readable description of why the relay failed, or null if there is no failure.

​
Relay status values

StatusMeaning
queuedThe relay is waiting to be submitted on-chain. The transaction has not been broadcast yet.
submittedThe transaction has been broadcast to the network and is awaiting mining.
confirmedThe transaction has been mined and confirmed on-chain.
failedThe relay encountered an error. Check failureReason and failedAt for details.

​
Errors

StatusCause
400The :id is not a valid UUID format.
404No relay transaction found with the given ID.
curl --request GET \
  --url https://api.arcpass.io/relay/c9d8e7f6-b5a4-3210-fedc-ba9876543210

{
  "id": "c9d8e7f6-b5a4-3210-fedc-ba9876543210",
  "sponsorshipRequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "submitted",
  "relayAttempt": 1,
  "transactionHash": "0xdeadbeefcafe1234567890abcdef1234567890abcdef1234567890abcdef1234",
  "submittedAt": "2025-05-11T10:31:05.000Z",
  "confirmedAt": null,
  "failedAt": null,
  "failureReason": null
}