Identity Fields

Skyfire uses one shared set of verified identity fields across its APIs. The same fields appear on both sides of a transaction: a seller can require them, and a buyer can share them. Both the buyer and seller APIs draw from the single catalog on this page.

First, get verified. These fields only carry data once you've verified your identity. Both buyers and sellers verify the same way: in the Skyfire Dashboard, click Get Verified on your home page, or open Account Settings and follow the steps. Verification is tied to your user, so once complete, both your buyer and seller agents can use it.

How identity fields are used

The same field set is referenced two ways, depending on who's acting:

Sellers require fields

humanIdentityRequirement — set in Create Agent's Service.

Defines which identity fields a buyer must have verified before they can create tokens for the service. It acts as an access requirement.

Buyers share fields

identityPermissions — set in Create Token.

Defines which verified fields the buyer includes in a token, controlling what identity data is disclosed to the seller.

Key idea: any field a seller can require through humanIdentityRequirement can also be requested by a buyer through identityPermissions. It's one field set, used from two sides.

Examples

A seller requires buyers to have verified their birthdate and family name before creating tokens for the service:

POST https://api.skyfire.xyz/api/v1/agents/seller-services
skyfire-api-key: {{SELLER_AGENT_API_KEY}}
content-type: application/json

{
  "name": "Weather Data API Service",
  "description": "Real-time weather data and forecasts.",
  "type": "API",
  "price": "0.01",
  "priceModel": "PAY_PER_USE",
  "minimumTokenAmount": "0.01",
  "humanIdentityRequirement": {
    "individual": ["birthdate", "family_name"],
    "organization": ["birthdate", "family_name"]
  }
}

Empty Requirements

A seller can set both "individual" and "organization" to empty arrays in humanIdentityRequirement:

{
  "individual": [],
  "organization": []
}

This means either only a verified email is required, and no additional identity verification is enforced.

Field reference

A Skyfire user is either an individual or an organization, and each type supports its own set of fields. Use the exact field names below in both humanIdentityRequirement and identityPermissions.

Individual

Level 1 · Basic identity

Field name	Type
`birthdate`	`string`
`given_name`	`string`
`middle_name`	`string`
`family_name`	`string`
`phone_number`	`string`
`phone_country_code`	`string`

Level 2 · Extended identity

Includes all Level 1 fields, plus:

Field name	Type
`id_document.issued_on`	`string`
`id_document.expires_on`	`string`
`id_document.issued_by`	`string`
`address-full`	`string`
`address-city`	`string`
`address-region`	`string`
`address-country`	`string`
`no-address`	`string`

Level 2 verification automatically includes all Level 1 fields.

Organization

Field name	Type
`organization_name`	`string`
`organization_tax_id`	`string`
`organization_physical_address-full`	`string`
`organization_physical_address-city`	`string`
`organization_physical_address-region`	`string`
`organization_physical_address-country`	`string`
`no-organization_physical_address`	`string`
`organization_registered_address-full`	`string`
`organization_registered_address-city`	`string`
`organization_registered_address-region`	`string`
`organization_registered_address-country`	`string`
`no-organization_registered_address`	`string`
`birthdate`	`string`
`given_name`	`string`
`middle_name`	`string`
`family_name`	`string`
`phone_number`	`string`
`phone_country_code`	`string`