Light mode version of Land Your Home
V1Access requests

Post Transaction Access Request

POST
/v1/transactions/{transactionId}/access-requests

Asks to join a transaction (here a neighbour in the user's chain). Asking again while a request is pending returns the same request with 200 and existing: true. If the user is already a party the response is 409 conflict.

Required variables:

  • baseUrl
  • apiKey (needs requests:write)
  • userToken
  • neighbourTransactionId (set by chains/Get Chain)

Authorization

bearerAuth userTokenAuth
AuthorizationBearer <token>

Partner API key (lyh_...): identifies the calling partner, its scopes and rate limit.

In: header

X-User-Token<token>

The user's OAuth 2.1 access token, issued by Land Your Home's OAuth server to this partner's OAuth client. Requests run as this user.

In: header

Path Parameters

transactionId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/transactions/string/access-requests"
{  "data": {    "id": "b3b6f1d2-8f0a-4c53-9b6e-6a4b1b1c0a77",    "existing": true  }}

Post Access Request Accept

Accepts someone's request to join a transaction, adding them as a party. The user needs transactionParty.canEdit on it and can't grant more than they hold. A request that doesn't exist is notfound; the success state is an example (the executed collection has no one else's request to accept).

Get My Address Book

Happy path: the other active people on every chain the user is in, with their role on each transaction. Details a person doesn't share with this user are null.