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

post

https://api3.fabrica.land/on-ramp/{networkName}/{contractAddress}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contractAddress

string

required

networkName

string

enum

required

Allowed:

Body Params

ownerType

string

enum

required

Whether the property is currently owned by an individual person or a legal entity

Allowed:

legalFirstName

string

required

The legal first (given) name either of the current owner of the property, or of the person authorized to transfer ownership of the property on behalf of the entity that owns the property

legalMiddleName

string | null

required

The legal middle name or initial either of the current owner of the property, or of the person authorized to transfer ownership of the property on behalf of the entity that owns the property

legalLastName

string

required

The legal last name (surname) either of the current owner of the property, or of the person authorized to transfer ownership of the property on behalf of the entity that owns the property

legalFullName

string

required

The legal full name either of the current owner of the property, or of the person authorized to transfer ownership of the property on behalf of the entity that owns the property

string

The email address of the person minting the token

country

string

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

adminId

string

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

propertyId

string

length ≥ 1

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

lat

number

The latitude of the property

lon

number

The longitude of the property

geoJson

string

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

acres

number

The total area of the land parcel, in acres

vendor

string

enum

The vendor used to lookup the value; correlates with vendorId

Allowed:

vendorId

string

length ≥ 1

The ID of the property at the vendor specified in vendor

clientInput

string

length ≥ 1

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

recipients

object

required

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

incorporationJurisdiction

string | null

For entity owners only, the full jursidiction name (e.g.: California) in which the owning entity is incorporated

entityType

string | null

enum

For entity owners only, the type of the entity

entityName

string | null

For entity owners only, the legal name of the entity

entityRole

string | null

For entity owners only, the role within the entity of the person submitted for the legalFullName property

additionalFields

array of objects

additionalFields

legalDescription

string

length ≥ 1

The legal description of the property: if left out, it will be looked up in DataTree

userDescription

string

length ≥ 1

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

media

array of objects

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

media

documents

array of objects

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

documents

Response

201