Submit Permit - Relay

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

cURL

curl --request POST \
  --url https://api.relay.link/execute/permits \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "<string>",
  "requestId": "<string>"
}
'

JavaScript

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({kind: '<string>', requestId: '<string>'})
};

fetch('https://api.relay.link/execute/permits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Python

import requests

url = "https://api.relay.link/execute/permits"

payload = {
    "kind": "<string>",
    "requestId": "<string>"
}
hheaders = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response Codes

• 200
• 400

Response Body Structure

{
  "message": "<string>",
  "steps": [
    {
      "id": "<string>",
      "action": "<string>",
      "description": "<string>",
      "kind": "<string>",
      "items": [
        {
          "status": "<string>",
          "data": {
            "to": "<string>",
            "data": "<string>",
            "value": "<string>",
            "chainId": 123
          },
          "check": {
            "endpoint": "<string>",
            "method": "<string>"
          }
        }
      ]
    }
  ]
}

{
  "message": "<string>"
}

Headers

• x-api-key: string - Optional API key for authentication and higher rate limits.

Query Parameters

• signature: string - required - The permit signature.

Body Parameters

• kind: string - required - The kind of signature. This value is returned in the quote API steps body field. e.g eip3009
• requestId: string - required - The requestId of the quote this permit signature applies to. Returned in the quote API steps body field.
• api: enum - The API value returned from the quote API steps body field.

Available options: bridge, swap, user-swap

Response

• 200: application/json

• message: string

  • steps: object[]