On-ramp a property to Fabrica as a premint, for later minting

This allows for Fabrica to perform async research and preparation required to be completed before a token can be minted

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
enum
required
Allowed:
Body Params
string
^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$

The email address of the person minting the token

string
^0x[a-fA-F0-9]{40}$

The wallet address of the person minting the token

string
[A-Z]{2}([-_][A-Z0-9]{2})?

The ISO-3166-1 (two-letter country code) or ISO-3166-2 (with 2 or 3 upercase letter or numeric subdivision code after a hyphen), of the property

string
^[0-9]+$

A positive integer string (leading zeroes allowed): in the US, this is the county FIPS code

string
length ≥ 1

In the US, this is the parcel number, or APN

number

The latitude of the property

number

The longitude of the property

string

The boundary shape of the property: if left out, will be retrieved from the vendor

number

The total area of the land parcel, in acres

string | null

The region of the property (state name in the US

string | null

The region code of the property (two-letter state abbreviation in the US

string | null

The postal code of the property (the zip code in the US

string | null

The district of the property (the county in the US

string | null

The place of the property (the town or city name in the US

string | null

The locality of the property (the village name in the US

string | null

The name of the neighborhood of the property

string | null

The name of the street of the property

string | null

The full address of the property

string | null

A preferred name for the property, supplied by partners or owners

string
enum

The vendor used to lookup the value; correlates with vendorId

Allowed:
string
length ≥ 1

The ID of the property at the vendor specified in vendor

string
enum

The partner that originated this listing; correlates with partnerId

Allowed:
string
length ≥ 1

The ID of the property at the partner specified in partner

string
length ≥ 1

The input-box content the web-site visitor accepted when searching for the property

recipients
object

A map of Ethereum addresses to how much supply of the token should be allocated to each address

collectedFields
object
string | null
.*\S.*

The legal description of the property: if left out, it will be looked up in DataTree. Pass null to explicitly clear.

string
length ≥ 1
.*\S.*

A marketing description for the property: if left out, we will use AI to generate one

media
array of objects
length ≤ 200

A list of images and videos to include in the property's configuration

media
documents
array of objects
length ≤ 100

A list of documents to include in the property's configuration

documents
string | null

Ignored for writes since 2.2; the pair is set only by a signed QR scan

uuid | null

Ignored for writes since 2.2; the pair is set only by a signed QR scan

grantors
array of objects
length between 1 and 100
grantors
Headers
string

ENG-5176: run id from the admin run cost allowance API. The Regrid and ATTOM spend of this start, and of an AVM job it enqueues, counts against that run allowance. An unknown, closed or lapsed run id refuses the paid calls.

string

Lets a non-admin update an existing unclaimed on-ramp. Without it a non-admin start returns the redacted record and writes nothing. An authenticated caller keeps the secret. A logged-out caller that presents the current secret gets a new sessionId that replaces it. A logged-out caller without the current secret gets no sessionId.

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json