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 these endpoints to check the current state of a sponsorship request. You can look up a request either by its UUID (assigned at creation) or by the on-chain transaction hash if the request has been relayed.

Get by UUID

GET /sponsorship/:id
id
string
required
UUID of the sponsorship request, returned when you called POST /sponsorship/request.
id
string
required
UUID of the sponsorship request.
walletAddress
string
required
Ethereum address submitted for sponsorship.
status
string
required
Current lifecycle status of the sponsorship request. See the status table below.
requestedAt
string
required
ISO 8601 timestamp of when the request was created.
ipAddress
string
IP address of the client that submitted the request.
userAgent
string
User-agent string from the original request, or null if not captured.

Get by transaction hash

GET /sponsorship/tx/:hash Use this endpoint to find a sponsorship request using an on-chain transaction hash. This is useful if you have a transactionHash from a relay record and want to trace it back to the originating sponsorship request.
hash
string
required
The on-chain transaction hash. Accepts any non-empty string up to 1,024 characters.

Sponsorship status values

StatusMeaning
pendingThe request has been received and is awaiting review.
approvedThe request passed eligibility checks and is queued for relay.
relayedA relay transaction has been submitted on-chain.
completedThe relay transaction was confirmed on-chain.
rejectedThe request failed eligibility checks and will not be sponsored.
failedThe relay transaction failed after being submitted.
Status transitions are strictly enforced: pendingapproved or rejected, approvedrelayed, relayedcompleted or failed. Terminal states (rejected, completed, failed) cannot transition further.

Errors

StatusCause
400The :id is not a valid UUID format.
404No sponsorship request found with the given ID or transaction hash.
curl --request GET \
  --url https://api.arcpass.io/sponsorship/a1b2c3d4-e5f6-7890-abcd-ef1234567890
200
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "walletAddress": "0xabc1234567890def1234567890abcdef12345678",
  "status": "relayed",
  "requestedAt": "2025-05-11T10:30:00.000Z",
  "ipAddress": "203.0.113.42",
  "userAgent": "Mozilla/5.0 (compatible; ArcApp/1.0)"
}