@raytio/types 7.2.0 → 8.0.0

package/README.md

@@ -37,36 +37,74 @@ Hovering over the type in VSCode will display documentation and available proper
 - [AA](#aa)
 - [AATag](#aatag)
 - [AId](#aid)
+- [CId](#cid)
 - [Colors](#colors)
+- [CommonFields](#commonfields)
 - [CommonSchemaAttributes](#commonschemaattributes)
 - [ConditionallyRequired](#conditionallyrequired)
 - [ContactPoint](#contactpoint)
+- [ContentUrl](#contenturl)
 - [CustomFonts](#customfonts)
+- [Customer](#customer)
+- [CustomerSite](#customersite)
+- [CustomerSiteUse](#customersiteuse)
+- [CustomerUser](#customeruser)
 - [DataTypes](#datatypes)
 - [Encrypted](#encrypted)
 - [GId](#gid)
+- [GPMId](#gpmid)
 - [IId](#iid)
 - [Instance](#instance)
+- [InstanceWithoutData](#instancewithoutdata)
+- [KId](#kid)
 - [LId](#lid)
+- [LOCId](#locid)
+- [Link](#link)
 - [Location](#location)
 - [Lookup](#lookup)
+- [MId](#mid)
+- [Merchant](#merchant)
+- [MerchantApprovalStatusCode](#merchantapprovalstatuscode)
+- [MerchantClassCode](#merchantclasscode)
+- [MerchantStatusCode](#merchantstatuscode)
+- [MerchantTypeCode](#merchanttypecode)
 - [NId](#nid)
+- [NId2](#nid2)
 - [OId](#oid)
 - [Organization](#organization)
+- [PCId](#pcid)
 - [PId](#pid)
+- [PKId](#pkid)
+- [PLId](#plid)
+- [PLLId](#pllid)
+- [PMId](#pmid)
+- [PRCId](#prcid)
+- [PRid](#prid)
+- [PTId](#ptid)
 - [Party](#party)
 - [PartyMetadata](#partymetadata)
 - [PartySite](#partysite)
+- [PaymentMethod](#paymentmethod)
+- [PaymentProcessor](#paymentprocessor)
+- [PermissionType](#permissiontype)
+- [PriceList](#pricelist)
+- [PriceListLine](#pricelistline)
 - [ProfileObject](#profileobject)
 - [RealVer](#realver)
 - [Relationship](#relationship)
+- [SId](#sid)
+- [SLId](#slid)
 - [Schema](#schema)
 - [SchemaField](#schemafield)
 - [SchemaFieldTag](#schemafieldtag)
+- [SchemaName](#schemaname)
 - [SchemaTag](#schematag)
 - [SchemaType](#schematype)
 - [ServerSchemaField](#serverschemafield)
 - [SubmissionStatus](#submissionstatus)
+- [Subscription](#subscription)
+- [SubscriptionLine](#subscriptionline)
+- [TId](#tid)
 - [UId](#uid)
 - [Urn](#urn)
 - [UrnNodeType](#urnnodetype)
@@ -74,7 +112,9 @@ Hovering over the type in VSCode will display documentation and available proper
 - [Verification](#verification)
 - [VerificationPayload](#verificationpayload)
 - [VerificationProvider](#verificationprovider)
+- [VerificationType](#verificationtype)
 - [WId](#wid)
+- [WSId](#wsid)
 - [Webhook](#webhook)
 - [WebhookStatus](#webhookstatus)
 - [WizardConfig](#wizardconfig)
@@ -98,13 +138,14 @@ Hovering over the type in VSCode will display documentation and available proper
 | `active?` | `boolean` | - |
 | `auth_list_enabled?` | `boolean` | if true, only specific email addresses can submit the form |
 | `callback_uri?` | `string`[] | - |
+| `customer_id` | [`CId`](#cid) | - |
 | `description?` | `string` | - |
 | `end_date?` | `Date` | - |
 | `key?` | `string` | - |
 | `logout_uri?` | `string`[] | - |
 | `metadata?` | `unknown` | - |
 | `name` | `string` | - |
-| `org_id` | [`OId`](#oid) | the id of the associated organization |
+| `org_id?` | [`OId`](#oid) | the id of the associated organization |
 | `picture?` | [`Urn`](#urn) | **`Deprecated`** see !2101 |
 | `picture_url?` | `string` | Easy to use AA logo url for pasting into emails |
 | `ruleset?` | `unknown` | configuration for the submission rules |
@@ -113,7 +154,7 @@ Hovering over the type in VSCode will display documentation and available proper
 | `service_provider_n_id?` | [`NId`](#nid) | the n_id of the associated service provider |
 | `start_date?` | `Date` | Currently Unused Attributes |
 | `tags?` | [`AATag`](#aatag)[] | - |
-| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](modules.md#customfonts)  } | - |
+| `theme?` | { `colors?`: [`Colors`](#colors) ; `font?`: [`CustomFonts`](#customfonts)  } | - |
 | `theme.colors?` | [`Colors`](#colors) | - |
 | `theme.font?` | [`CustomFonts`](#customfonts) | - |
 
@@ -133,6 +174,14 @@ An `a_id` is the ID of an [AA](#aa)
 
 ___
 
+### CId
+
+Ƭ **CId**: `StringWithIdentity`<``"CId"``\>
+
+A `c_id` is the ID of a [Customer](#customer), (will eventually replace org_id)
+
+___
+
 ### Colors
 
 Ƭ **Colors**: `Object`
@@ -166,6 +215,45 @@ ___
 
 ___
 
+### CommonFields
+
+Ƭ **CommonFields**<`IdType`, `Metadata`\>: `Object`
+
+Every object in the new database has these fields. In the
+interest of type-safety, the `id` should be one of the
+well-known IDs that extend StringWithIdentity (e.g.
+[NId](#nid) or [AId](#aid)). If the ID is irrelevant, then
+use `CommonFields<never>` rather than `CommonFields<string>`.
+This will deliberately prevent you from utilising the `id`
+field until you define a special type for that ID.
+
+This is especially important with the new API where it is much
+easier to mix up the different types of IDs.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `IdType` | extends `StringWithIdentity`<`string`\> |
+| `Metadata` | `unknown` |
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `active` | `boolean` | - |
+| `end_date` | `string` | ISO Date |
+| `id` | `IdType` | - |
+| `metadata` | `Metadata` \| `undefined` | - |
+| `resource_group?` | `string` | - |
+| `resource_name?` | `string` | - |
+| `resource_url?` | `string` | - |
+| `row_version?` | `number` | - |
+| `start_date` | `string` | ISO Date |
+| `tenant_id?` | `string` | - |
+
+___
+
 ### CommonSchemaAttributes
 
 Ƭ **CommonSchemaAttributes**: `Object`
@@ -178,7 +266,8 @@ not exported. Attributes that are identical in both client schema & server schem
 | :------ | :------ | :------ |
 | `description` | `string` | - |
 | `description_decorator?` | ``"md"`` | specifies that the description is formatted in markdown |
-| `display?` | { `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  }  } | - |
+| `display?` | { `compact_table?`: `boolean` ; `expand?`: { `fields`: `string`[] ; `label`: `string`  }[] ; `head_main?`: { `fields`: `string`[] ; `format?`: `string`  } ; `head_sub?`: { `fields`: `string`[] ; `format?`: `string`  } ; `tabular?`: { `fields`: `string`[]  }  } | - |
+| `display.compact_table?` | `boolean` | determines if profile pages should display using compacted 'MiniPO' view or deafult view |
 | `display.expand?` | { `fields`: `string`[] ; `label`: `string`  }[] | list of fields that should not be shown by default, unless you expand a collpase section which has a name from the label property. Array because there could be multiple expand groups |
 | `display.head_main?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the header/name of the PO fields joined with a space unless `format` format string is supplied |
 | `display.head_main.fields` | `string`[] | - |
@@ -186,13 +275,15 @@ not exported. Attributes that are identical in both client schema & server schem
 | `display.head_sub?` | { `fields`: `string`[] ; `format?`: `string`  } | list of fields to be considered the subheader of the PO fields joined with a space unless `format` format string is supplied |
 | `display.head_sub.fields` | `string`[] | - |
 | `display.head_sub.format?` | `string` | - |
+| `display.tabular?` | { `fields`: `string`[]  } | By default, the admin dashboard shows columns for all fields in listed in `head_main`. In rare cases you can use this property to specify a different set of fields to show to admins by default. |
+| `display.tabular.fields` | `string`[] | - |
 | `i18n?` | { `[locale: string]`: { `[fieldNameOrGroupName: string]`: [`ServerSchemaField`](#serverschemafield) & { `title_plural?`: `string`  }; `$loading_create_sub_obj`: { `title`: `string`  } ; `$loading_delete_pending_ver`: { `title`: `string`  } ; `$loading_extract`: { `title`: `string`  } ; `$loading_link_to_person`: { `title`: `string`  } ; `$loading_long_verification_message`: { `description?`: `string` ; `title?`: `string`  } ; `$loading_pending_ver_resubmit`: { `title`: `string`  } ; `$loading_permission`: { `title`: `string`  } ; `$loading_save`: { `title`: `string`  } ; `$loading_update`: { `title`: `string`  } ; `$loading_upload`: { `title`: `string`  } ; `$loading_verify`: { `title`: `string`  } ; `$schema`: { `description?`: `string` ; `title`: `string` ; `title_plural?`: `string`  }  };  } | - |
-| `onboard_properties?` | { `organizations?`: { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](modules.md#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](modules.md#organization)  }[] ; `profile_objects?`: { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: `string`  }[] ; `relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] ; `return_to?`: `string`  } | only the schema used for the onboarding wizard have this property |
-| `onboard_properties.organizations?` | { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](modules.md#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](modules.md#organization)  }[] | Organizations that should be created. NOTE: if multiple are specified, when the wizard completes, the _first one_ will be selected |
-| `onboard_properties.profile_objects?` | { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: `string`  }[] | Profile Objects that should be created |
+| `onboard_properties?` | { `organizations?`: { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#organization)  }[] ; `profile_objects?`: { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: [`SchemaName`](#schemaname)  }[] ; `relationships?`: { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] ; `return_to?`: `string`  } | only the schema used for the onboarding wizard have this property |
+| `onboard_properties.organizations?` | { `access_applications?`: { `links?`: { `description`: `string` ; `wizardConfig`: `Omit`<[`WizardConfig`](#wizardconfig), ``"a_id"``\>  }[] ; `properties`: `Omit`<[`AA`](#aa), ``"org_id"``\>  }[] ; `properties`: [`Organization`](#organization)  }[] | Organizations that should be created. NOTE: if multiple are specified, when the wizard completes, the _first one_ will be selected |
+| `onboard_properties.profile_objects?` | { `properties`: `Record`<`string`, `unknown`\> ; `schema_name`: [`SchemaName`](#schemaname)  }[] | Profile Objects that should be created |
 | `onboard_properties.relationships?` | { `from`: `string` ; `properties?`: `Record`<`string`, `string`\> ; `to`: `string` ; `type`: `string`  }[] | Relationships that should be created |
 | `onboard_properties.return_to?` | `string` | The relative path in the client to redirect to once finished. May include variables |
-| `relationships?` | { `anyOf?`: `string`[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: `string`[] ; `properties?`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
+| `relationships?` | { `anyOf?`: [`SchemaName`](#schemaname)[] ; `direction`: ``"from"`` ; `multiple?`: `boolean` ; `oneOf?`: ([`SchemaName`](#schemaname) \| ``"instance"``)[] ; `properties?`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `relationship_name`: `string` ; `required?`: `string`[] ; `required_relationship?`: `boolean` ; `type`: `string`  }[] | - |
 | `schema_group?` | `string` | the group that a schema belongs to, such as "passports". This is useful for forms that accept different types of similar documents. |
 | `schema_type?` | [`SchemaType`](#schematype) | - |
 | `tags?` | [`SchemaTag`](#schematag)[] | - |
@@ -218,30 +309,15 @@ ___
 
 ### ContactPoint
 
-Ƭ **ContactPoint**: `Object`
+Ƭ **ContactPoint**: [`CommonFields`](#commonfields)<[`PCId`](#pcid)\> & { `contact_point_purpose`: `string` ; `contact_point_type`: `string` ; `e164`: `string` \| ``null`` ; `e164_suffix`: `string` \| ``null`` ; `e164_type`: `string` \| ``null`` ; `email_address`: `string` ; `email_address_preferred_format`: `string` ; `party_id`: [`PRid`](#prid) ; `url`: `string` \| ``null`` ; `url_type`: `string` \| ``null`` ; `uuid`: `string` \| `undefined`  }
 
 A Contact Point for an Organization
 
-#### Type declaration
+___
 
-| Name | Type |
-| :------ | :------ |
-| `active` | `boolean` |
-| `contact_point_purpose` | `string` |
-| `contact_point_type` | `string` |
-| `e164` | `string` \| ``null`` |
-| `e164_suffix` | `string` \| ``null`` |
-| `e164_type` | `string` \| ``null`` |
-| `email_address` | `string` |
-| `email_address_preferred_format` | `string` |
-| `end_date` | `string` |
-| `id` | `string` |
-| `metadata` | `unknown` |
-| `start_date` | `string` |
-| `to_table` | `string` |
-| `url` | `string` \| ``null`` |
-| `url_type` | `string` \| ``null`` |
-| `uuid` | `string` \| `undefined` |
+### ContentUrl
+
+Ƭ **ContentUrl**: \`url:${string}\`
 
 ___
 
@@ -258,6 +334,34 @@ ___
 
 ___
 
+### Customer
+
+Ƭ **Customer**: [`CommonFields`](#commonfields)<[`CId`](#cid)\> & { `customer_code`: `string` ; `owner_email`: `string` ; `party_description`: [`OId`](#oid) ; `party_id`: [`PRid`](#prid) ; `permission_type`: [`PermissionType`](#permissiontype) \| ``null`` ; `prm_parties?`: [`Party`](#party) ; `user_email`: `string` ; `user_id`: [`UId`](#uid) \| ``null``  }
+
+An organization/customer, directly returned by the API
+
+___
+
+### CustomerSite
+
+Ƭ **CustomerSite**: [`CommonFields`](#commonfields)<`never`\> & { `customer_site_code`: `string` ; `customer_site_status_code`: `string` ; `org_id`: [`OId`](#oid) ; `party_site_id`: `string`  }
+
+___
+
+### CustomerSiteUse
+
+Ƭ **CustomerSiteUse**: [`CommonFields`](#commonfields)<`never`\> & { `customer_site_id`: `string` ; `customer_site_use_name`: `string` ; `customer_site_use_purpose_code`: `string` ; `freight_term_code`: `string` \| ``null`` ; `org_id`: [`OId`](#oid) ; `payment_term_id`: `string` ; `price_list_version_id`: `string` \| ``null``  }
+
+___
+
+### CustomerUser
+
+Ƭ **CustomerUser**: [`CommonFields`](#commonfields)<[`CId`](#cid)\> & { `customer_code`: `string` ; `group_name`: `string` \| ``null`` ; `owner_email`: `string` ; `owner_id`: [`UId`](#uid) ; `party_description`: [`OId`](#oid) ; `party_id`: [`PRid`](#prid) ; `party_name`: `string` ; `permission_type`: [`PermissionType`](#permissiontype) \| ``null`` ; `user_email`: `string` \| ``null`` ; `user_id`: [`UId`](#uid) \| ``null``  }
+
+Organization Customer / User, Returned directly by the API
+
+___
+
 ### DataTypes
 
 Ƭ **DataTypes**: ``"string"`` \| ``"number"`` \| ``"boolean"`` \| ``"object"`` \| ``"integer"`` \| ``"array"`` \| ``"null"``
@@ -295,6 +399,14 @@ A `g_id` is the ID of a group
 
 ___
 
+### GPMId
+
+Ƭ **GPMId**: `StringWithIdentity`<``"GPMId"``\>
+
+A `gpm_id` is the ID of a Verification Type
+
+___
+
 ### IId
 
 Ƭ **IId**: `StringWithIdentity`<``"IId"``\>
@@ -305,39 +417,24 @@ ___
 
 ### Instance
 
-Ƭ **Instance**: `Object`
+Ƭ **Instance**: [`InstanceWithoutData`](#instancewithoutdata) & { `keys`: { `[nId2: NId2]`: { `[fieldName: string]`: { `data`: `string`  };  };  } ; `profile_objects`: [`ProfileObject`](#profileobject)[] ; `relationships`: [`Relationship`](#relationship)[]  }
 
-#### Type declaration
+The API used to store data in this format, but it no
+longer does :( so `@raytio/core` reconstructs this object.
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `_state?` | [`SubmissionStatus`](#submissionstatus) | **`Deprecated`** The status of a submission |
-| `a_id` | [`AId`](#aid) | ID of the access application this submission was made to |
-| `aa_name` | `string` | name of the access application this submission was made to |
-| `aack_id?` | `string` | Key (Can be used to retrieve instance) |
-| `active?` | `boolean` | Activity Status |
-| `confirmation_code` | `string` | Code that validates information has been shared |
-| `data_provider_email` | `string` | Email of user who shared the data |
-| `device_id?` | `unknown` | Device Id |
-| `end_date` | `string` | Latest date in which the shared information was available |
-| `i_id` | [`IId`](#iid) | Access application instance ID |
-| `instance_version?` | `unknown` | Instance Version |
-| `keys` | { `[nId: NId]`: { `[fieldName: string]`: { `data`: `string` ; `n_id`: [`NId`](#nid)  };  };  } | - |
-| `metadata?` | `unknown` | Metadata |
-| `platform_footer_html?` | `unknown` | Footer Html |
-| `previous_state?` | [`SubmissionStatus`](#submissionstatus) | Previous status of the shared information |
-| `profile_objects` | [`ProfileObject`](#profileobject)[] | data associated is access application's instance |
-| `reference` | `string` | reference provided by the user who shared the data |
-| `related_offers?` | `unknown` | Related Offers |
-| `related_service_types?` | `unknown` | Related Service Types |
-| `relationships?` | [`Relationship`](#relationship)[] | - |
-| `score?` | `unknown` | added by the client once it calculates the score |
-| `service_provider_n_id?` | [`NId`](#nid) | Service provider ID |
-| `source_ip?` | `unknown` | Source IP |
-| `start_date` | `string` | Earliest date on which the shared information was available |
-| `state` | [`SubmissionStatus`](#submissionstatus) | The status of a submission |
-| `sub_service_provider_hash?` | `string` | Hash of the Service Provider ID |
-| `thread` | `string` | - |
+___
+
+### InstanceWithoutData
+
+Ƭ **InstanceWithoutData**: [`CommonFields`](#commonfields)<[`IId`](#iid), { `message?`: `string`  }\> & { `aa_id`: [`AId`](#aid) ; `aack_id`: [`KId`](#kid) ; `confirmation_code`: `string` ; `data_provider_email`: `string` ; `device_id?`: `unknown` ; `instance_version?`: `unknown` ; `platform_footer_html?`: `unknown` ; `previous_state?`: [`SubmissionStatus`](#submissionstatus) ; `reference`: `string` ; `related_offers?`: `unknown` ; `related_service_types?`: `unknown` ; `score?`: `unknown` ; `service_provider_n_id`: [`NId`](#nid) ; `source_ip?`: `unknown` ; `state`: [`SubmissionStatus`](#submissionstatus) ; `sub_service_provider_hash`: `string` ; `thread`: `string`  }
+
+___
+
+### KId
+
+Ƭ **KId**: `StringWithIdentity`<``"KId"``\>
+
+A `k_id` (also called a `aack_id` or a `publicKeyId`) is the ID of an AA's public key
 
 ___
 
@@ -349,42 +446,40 @@ An `l_id` is the ID of any data stored in the KV-Store
 
 ___
 
-### Location
+### LOCId
 
-Ƭ **Location**: `Object`
+Ƭ **LOCId**: `StringWithIdentity`<``"LOCId"``\>
 
-An Organization Location
+A `loc_id` is the ID of a location
+
+___
+
+### Link
+
+Ƭ **Link**: `Object`
+
+Link used for an Access Application, including all additional information
 
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `active` | `boolean` |
-| `address_line_1` | `string` \| ``null`` |
-| `address_line_2` | `string` \| ``null`` |
-| `address_line_3` | `string` \| ``null`` |
-| `address_line_4` | `string` \| ``null`` |
-| `administrative_area_level_1` | `string` \| ``null`` |
-| `administrative_area_level_2` | `string` \| ``null`` |
-| `administrative_area_level_3` | `string` \| ``null`` |
-| `city` | `string` \| ``null`` |
-| `country` | `string` \| ``null`` |
-| `end_date` | `string` |
-| `geolocation` | `string` \| ``null`` |
-| `geolocation_outline` | `string` \| ``null`` |
-| `id` | `string` |
-| `locality` | `string` \| ``null`` |
-| `location_description` | `string` \| ``null`` |
-| `location_name` | `string` |
-| `metadata` | `unknown` |
-| `postal_code` | `string` |
-| `postal_code_suffix` | `string` \| ``null`` |
-| `premise` | `string` \| ``null`` |
-| `region` | `string` \| ``null`` |
-| `route` | `string` \| ``null`` |
-| `start_date` | `string` |
-| `street_number` | `string` \| ``null`` |
-| `subpremise` | `string` \| ``null`` |
+| `a_id` | [`AId`](#aid) |
+| `code` | [`LId`](#lid) |
+| `details?` | [`AA`](#aa) |
+| `id` | [`NId`](#nid) |
+| `isDefault?` | `boolean` |
+| `name` | `string` |
+| `subtitle` | `string` |
+| `url` | `string` |
+
+___
+
+### Location
+
+Ƭ **Location**: [`CommonFields`](#commonfields)<[`LOCId`](#locid)\> & { `address_line_1`: `string` \| ``null`` ; `address_line_2`: `string` \| ``null`` ; `address_line_3`: `string` \| ``null`` ; `address_line_4`: `string` \| ``null`` ; `administrative_area_level_1`: `string` \| ``null`` ; `administrative_area_level_2`: `string` \| ``null`` ; `administrative_area_level_3`: `string` \| ``null`` ; `city`: `string` \| ``null`` ; `country`: `string` \| ``null`` ; `geolocation`: `string` \| ``null`` ; `geolocation_outline`: `string` \| ``null`` ; `locality`: `string` \| ``null`` ; `location_description`: `string` \| ``null`` ; `location_name`: `string` ; `postal_code`: `string` ; `postal_code_suffix`: `string` \| ``null`` ; `premise`: `string` \| ``null`` ; `region`: `string` \| ``null`` ; `route`: `string` \| ``null`` ; `street_number`: `string` \| ``null`` ; `subpremise`: `string` \| ``null``  }
+
+An Organization Location
 
 ___
 
@@ -405,6 +500,44 @@ ___
 
 ___
 
+### MId
+
+Ƭ **MId**: `StringWithIdentity`<``"MId"``\>
+
+A `m_id` is the ID of a Merchant
+
+___
+
+### Merchant
+
+Ƭ **Merchant**: [`CommonFields`](#commonfields)<[`MId`](#mid)\> & { `merchant_approval_status_code`: [`MerchantApprovalStatusCode`](#merchantapprovalstatuscode) \| ``null`` ; `merchant_class_code`: [`MerchantClassCode`](#merchantclasscode) \| ``null`` ; `merchant_common_name`: `string` \| ``null`` ; `merchant_common_name_i18n`: `Json` \| ``null`` ; `merchant_description`: `string` \| ``null`` ; `merchant_description_i18n`: `Json` \| ``null`` ; `merchant_image_url_logo`: `string` \| ``null`` ; `merchant_image_url_thumbnail`: `string` \| ``null`` ; `merchant_name`: `string` \| ``null`` ; `merchant_name_i18n`: `Json` \| ``null`` ; `merchant_status_code`: [`MerchantStatusCode`](#merchantstatuscode) \| ``null`` ; `merchant_type_code`: [`MerchantTypeCode`](#merchanttypecode) \| ``null`` ; `party_id`: [`PRid`](#prid)  }
+
+___
+
+### MerchantApprovalStatusCode
+
+Ƭ **MerchantApprovalStatusCode**: ``"PENDING"`` \| ``"APPROVED"``
+
+___
+
+### MerchantClassCode
+
+Ƭ **MerchantClassCode**: ``"CLASS_1"`` \| ``"CLASS_2"``
+
+___
+
+### MerchantStatusCode
+
+Ƭ **MerchantStatusCode**: ``"ACTIVE"`` \| ``"INACTIVE"``
+
+___
+
+### MerchantTypeCode
+
+Ƭ **MerchantTypeCode**: ``"TYPE_1"`` \| ``"TYPE_2"``
+
+___
+
 ### NId
 
 Ƭ **NId**: `StringWithIdentity`<``"NId"``\>
@@ -413,12 +546,22 @@ An `n_id` is the ID of a [ProfileObject](#profileobject)
 
 ___
 
+### NId2
+
+Ƭ **NId2**: `StringWithIdentity`<``"NId2"``\>
+
+⚠️ This ID duplicates the [NId](#nid) and should only be used in exceptional circumstances
+
+___
+
 ### OId
 
 Ƭ **OId**: `StringWithIdentity`<``"OId"``\>
 
 An `o_id` is the ID of an [Organization](#organization)
 
+NOTE: Will be deprecated soon. Use CId instead.
+
 ___
 
 ### Organization
@@ -432,11 +575,20 @@ NOTE: this is different to how the schema defines an Organization. **The schema
 
 | Name | Type |
 | :------ | :------ |
-| `address` | `unknown` |
-| `customer` | `unknown` |
-| `email` | `string` |
-| `id` | [`OId`](#oid) |
+| `address?` | `unknown` |
+| `contact_point?` | `Pick`<[`ContactPoint`](#contactpoint), ``"email_address"`` \| ``"id"``\> |
+| `customerUsers` | [`CustomerUser`](#customeruser)[] |
+| `id` | [`CId`](#cid) |
 | `name` | `string` |
+| `orgId` | [`OId`](#oid) |
+
+___
+
+### PCId
+
+Ƭ **PCId**: `StringWithIdentity`<``"PCId"``\>
+
+A `pc_id` is the ID of a Party Contact Point
 
 ___
 
@@ -448,25 +600,65 @@ A `p_id` is the ID of a [Relationship](#relationship)
 
 ___
 
-### Party
+### PKId
 
-Ƭ **Party**: `Object`
+Ƭ **PKId**: `StringWithIdentity`<``"PKId"``\>
 
-An Organisation
+A `pk_id` is the ID of an AA's private key
 
-#### Type declaration
+___
 
-| Name | Type |
-| :------ | :------ |
-| `active` | `boolean` |
-| `end_date` | `string` |
-| `id` | `string` |
-| `metadata` | [`PartyMetadata`](#partymetadata) |
-| `party_description` | `string` |
-| `party_name` | `string` |
-| `party_number` | `number` |
-| `party_type` | `string` |
-| `start_date` | `string` |
+### PLId
+
+Ƭ **PLId**: `StringWithIdentity`<``"PLId"``\>
+
+A `pl_id` is the ID of a PriceList
+
+___
+
+### PLLId
+
+Ƭ **PLLId**: `StringWithIdentity`<``"PLLId"``\>
+
+A `pll_id` is the ID of a PriceListLine/Plan
+
+___
+
+### PMId
+
+Ƭ **PMId**: `StringWithIdentity`<``"PMId"``\>
+
+A `pm_id` is the ID of a PaymentMethod
+
+___
+
+### PRCId
+
+Ƭ **PRCId**: `StringWithIdentity`<``"PRCId"``\>
+
+A `prc_id` is the ID of a Price
+
+___
+
+### PRid
+
+Ƭ **PRid**: `StringWithIdentity`<``"PRid"``\>
+
+A `pr_id` is the ID of a [Party](#party)
+
+___
+
+### PTId
+
+Ƭ **PTId**: `StringWithIdentity`<``"PTId"``\>
+
+A `pt_id` is the ID of a PaymentProcessor
+
+___
+
+### Party
+
+Ƭ **Party**: [`CommonFields`](#commonfields)<[`PRid`](#prid), [`PartyMetadata`](#partymetadata)\> & { `far_customers`: [`CommonFields`](#commonfields)<[`CId`](#cid)\> & { `customer_approval_status_code`: `string` ; `customer_class_code`: `string` ; `customer_status_code`: `string` ; `customer_type_code`: `string` ; `far_customers_customer_approval_status_lookup`: [`Lookup`](#lookup) ; `far_customers_customer_class_lookup`: [`Lookup`](#lookup) ; `far_customers_customer_status_lookup`: [`Lookup`](#lookup) ; `far_customers_customer_type_lookup`: [`Lookup`](#lookup) ; `far_customers_freight_terms_lookup`: [`Lookup`](#lookup) ; `freight_term_code`: `string` ; `price_list_version_id`: `string` \| ``null``  }[] ; `party_description`: [`OId`](#oid) ; `party_image_url_logo`: `string` \| ``null`` ; `party_name`: `string` ; `party_type`: `string`  }
 
 ___
 
@@ -489,32 +681,81 @@ ___
 
 ### PartySite
 
-Ƭ **PartySite**: `Object`
+Ƭ **PartySite**: [`CommonFields`](#commonfields)<`never`\> & { `location_id`: `number` ; `party_id`: [`PRid`](#prid) ; `party_site_description`: `string` \| ``null`` ; `party_site_name`: `string` ; `party_use_primary`: `string` ; `party_uses`: `string`[]  }
 
 An Organization Site
 
+___
+
+### PaymentMethod
+
+Ƭ **PaymentMethod**: [`CommonFields`](#commonfields)<[`PMId`](#pmid)\> & { `address_line1_check?`: `string` \| ``null`` ; `address_postal_code_check?`: `string` \| ``null`` ; `card_expiry_month`: `number` ; `card_expiry_year`: `number` ; `card_fingerprint?`: `string` \| ``null`` ; `card_funding_method`: `string` ; `card_last_4_digits`: `string` ; `customer_id`: [`CId`](#cid) ; `cvc_check?`: `string` \| ``null`` ; `payer_payment_method_type`: `string` ; `payment_method_available_networks`: `string`[] \| `string` ; `payment_method_country_code`: `string` \| ``null`` ; `payment_method_preferred_network?`: `string` \| ``null`` ; `payment_method_scheme`: `string` ; `payment_processor_id`: `string` ; `payment_processor_payment_method_id`: `string` ; `primary_payment_method`: `boolean` ; `three_d_secure_usage?`: `string` \| ``null``  }
+
+___
+
+### PaymentProcessor
+
+Ƭ **PaymentProcessor**: [`CommonFields`](#commonfields)<[`PTId`](#ptid)\> & { `party_id`: [`PRid`](#prid) ; `payment_processor_name`: `string` ; `payment_processor_system`: `string`  }
+
+___
+
+### PermissionType
+
+Ƭ **PermissionType**: ``"ADMINS"`` \| ``"VIEWS"`` \| ``"EDITS"`` \| ``"OWNS"``
+
+___
+
+### PriceList
+
+Ƭ **PriceList**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `id` | [`PLId`](#plid) |
+| `pcm_price_list_versions?` | [{ `id`: `string` ; `pcm_price_list_lines`: [`PriceListLine`](#pricelistline)[] ; `price_list_version_name`: `string`  }] |
+| `price_list_currency` | `string` |
+| `price_list_description?` | `string` |
+| `price_list_description_i18n?` | `string` |
+| `price_list_name` | `string` |
+| `price_list_name_i18n?` | `string` |
+| `price_list_type` | `string` |
+
+___
+
+### PriceListLine
+
+Ƭ **PriceListLine**: `Object`
+
 #### Type declaration
 
 | Name | Type |
 | :------ | :------ |
-| `active` | `boolean` |
-| `end_date` | `string` |
-| `id` | `string` |
-| `location_number` | `number` |
-| `metadata` | `unknown` |
-| `party_id` | `string` |
-| `party_site_description` | `string` \| ``null`` |
-| `party_site_name` | `string` |
-| `party_site_number` | `string` \| ``null`` |
-| `party_use_primary` | `string` |
-| `party_uses` | `string`[] |
-| `start_date` | `string` |
+| `id` | [`PLLId`](#pllid) |
+| `pcm_prices` | { `amount`: `number` ; `billing_recurrence`: `string` ; `gpm_items`: { `id`: `string` ; `item_description`: `string` ; `item_description_i18n`: `string` \| ``null`` ; `item_key`: `string` ; `item_name`: `string` ; `item_name_i18n`: `string` \| ``null`` ; `primary_uom`: `string`  } ; `id`: [`PRCId`](#prcid) ; `price_currency`: `string` ; `recurring_billing_interval`: `string` \| ``null`` ; `recurring_billing_interval_count`: `number` ; `recurring_billing_scheme`: `string` ; `recurring_billing_usage_type`: `string`  } |
+| `pcm_prices.amount` | `number` |
+| `pcm_prices.billing_recurrence` | `string` |
+| `pcm_prices.gpm_items` | { `id`: `string` ; `item_description`: `string` ; `item_description_i18n`: `string` \| ``null`` ; `item_key`: `string` ; `item_name`: `string` ; `item_name_i18n`: `string` \| ``null`` ; `primary_uom`: `string`  } |
+| `pcm_prices.gpm_items.id` | `string` |
+| `pcm_prices.gpm_items.item_description` | `string` |
+| `pcm_prices.gpm_items.item_description_i18n` | `string` \| ``null`` |
+| `pcm_prices.gpm_items.item_key` | `string` |
+| `pcm_prices.gpm_items.item_name` | `string` |
+| `pcm_prices.gpm_items.item_name_i18n` | `string` \| ``null`` |
+| `pcm_prices.gpm_items.primary_uom` | `string` |
+| `pcm_prices.id` | [`PRCId`](#prcid) |
+| `pcm_prices.price_currency` | `string` |
+| `pcm_prices.recurring_billing_interval` | `string` \| ``null`` |
+| `pcm_prices.recurring_billing_interval_count` | `number` |
+| `pcm_prices.recurring_billing_scheme` | `string` |
+| `pcm_prices.recurring_billing_usage_type` | `string` |
 
 ___
 
 ### ProfileObject
 
-Ƭ **ProfileObject**<`Properties`\>: `Object`
+Ƭ **ProfileObject**<`Properties`\>: `Partial`<[`CommonFields`](#commonfields)<[`NId2`](#nid2)\>\> & { `labels`: `string`[] ; `n_id`: [`NId`](#nid) ; `properties`: `Properties`  }
 
 You can supply an option type argument if you know exactly what the properties will be
 
@@ -524,14 +765,6 @@ You can supply an option type argument if you know exactly what the properties w
 | :------ | :------ |
 | `Properties` | `Json` |
 
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `labels` | `string`[] |
-| `n_id` | [`NId`](#nid) |
-| `properties` | `Properties` |
-
 ___
 
 ### RealVer
@@ -565,19 +798,38 @@ ___
 
 | Name | Type |
 | :------ | :------ |
+| `active?` | `boolean` |
 | `end` | [`Urn`](#urn) |
+| `end_date?` | `string` |
 | `p_id` | [`PId`](#pid) |
 | `properties?` | { `[fieldName: string]`: `unknown`; `name?`: `string` ; `p_id`: [`PId`](#pid)  } |
 | `properties.name?` | `string` |
 | `properties.p_id` | [`PId`](#pid) |
 | `start` | [`Urn`](#urn) |
+| `start_date?` | `string` |
 | `type` | `string` |
 
 ___
 
+### SId
+
+Ƭ **SId**: `StringWithIdentity`<``"SId"``\>
+
+A `s_id` is the ID of a Subscription
+
+___
+
+### SLId
+
+Ƭ **SLId**: `StringWithIdentity`<``"SLId"``\>
+
+A `sl_id` is the ID of a SubscriptionLine
+
+___
+
 ### Schema
 
-Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `name`: `string` ; `properties`: { `[fieldName: string]`: [`SchemaField`](modules.md#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](modules.md#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](modules.md#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
+Ƭ **Schema**: [`CommonSchemaAttributes`](#commonschemaattributes) & { `clientLocale?`: `string` ; `database?`: { `primary_key`: `string` ; `table`: `string`  } ; `end_date?`: `string` ; `groupNames?`: `Record`<`string`, `string`\> ; `group_title?`: `string` ; `isProfileSchema?`: `boolean` ; `isSpSchema?`: `boolean` ; `name`: [`SchemaName`](#schemaname) ; `properties`: { `[fieldName: string]`: [`SchemaField`](#schemafield);  } ; `required?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `start_date?`: `string` ; `timing?`: `Record`<``"extract"`` \| ``"live_person"`` \| ``"verify_pending_delay"``, `number`\> ; `type?`: [`DataTypes`](#datatypes) ; `verified_fields?`: (`string` \| [`ConditionallyRequired`](#conditionallyrequired))[] ; `version`: `string` ; `wasExpandedByClient?`: `boolean`  }
 
 Raytio's variant of JSON Schema, as used by the client. It is a modified version
 of what the API returns.
@@ -593,12 +845,13 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `$id?` | `string` | **`Deprecated`** don't use, it's inconsistent |
-| `$ref?` | `string` | If this field refers to a sub-object |
+| `$ref?` | [`SchemaName`](#schemaname) | If this field refers to a sub-object |
 | `add_row_btn_label?` | `string` | if this field is a table input, this determines the text to show on the "Add Row" btn |
 | `allOf?` | [{ `$ref`: `string`  }, [`ServerSchemaField`](#serverschemafield)] | - |
 | `content?` | `string` | only checkbox uses this prop |
 | `contentEncoding?` | ``"base64"`` | - |
 | `contentMediaType?` | `string` | - |
+| `content_source?` | `string` | determines where an image is sourced from |
 | `default?` | `unknown` | the default value |
 | `default_signature_name?` | `string` | used on fields that are a signature file picker, see !849 also used to determine if the MediaPicker should be shown inline |
 | `description?` | `string` | - |
@@ -607,9 +860,11 @@ ___
 | `encrypt_require?` | `boolean` | if true, the user must have encryption enabled to save this data, see #1324 |
 | `enum?` | (`string` \| `number` \| `boolean`)[] | - |
 | `examples?` | `unknown`[] | - |
+| `foreign_key_of?` | [`SchemaName`](#schemaname) | if this field is a foreign key, i.e. it is a primary key of a different schema, then that other's schema name should be listed here. e.g. ```json { "name": "ss_AA", "properties": { "org_id": { "foreign_key_of": "ss_Org" } } } ``` |
 | `format?` | ``"date"`` \| ``"date-time"`` \| ``"uri"`` | - |
+| `hash_inputs?` | `string` | the input string for a platform_unique_id |
 | `image_silhouette?` | `string` | If this schema requires a photo of a document, you can specify a URL to a silhouette image which will be overlaid on top of the camera. For best results, the image should have a transparent background + minimal white foreground |
-| `items?` | { `properties`: { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } ; `type`: [`DataTypes`](modules.md#datatypes)  } | `items` is used for nested arrays, (while `properties` is used for nested objects) |
+| `items?` | { `properties`: { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } ; `type`: [`DataTypes`](#datatypes)  } | `items` is used for nested arrays, (while `properties` is used for nested objects) |
 | `items.properties` | { `[subFieldName: string]`: [`SchemaField`](#schemafield);  } | - |
 | `items.type` | [`DataTypes`](#datatypes) | - |
 | `lookup?` | `string` | URL to a JSON file in the `Lookup` format |
@@ -636,13 +891,21 @@ ___
 
 ### SchemaFieldTag
 
-Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| \`display:replace:'${string}':'${string}'\` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:client_upload"`` \| ``"action:require_webauthn"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
+Ƭ **SchemaFieldTag**: ``"password"`` \| \`group:${string}\` \| \`upload-group:${string}\` \| ``"display:stars"`` \| ``"display:no_autofill"`` \| ``"display:currency"`` \| ``"display:cascade"`` \| ``"display:survey"`` \| ``"display:quoting"`` \| ``"display:customModal"`` \| ``"display:mask"`` \| \`display:replace:('${string}', '${string}')\` \| ``"display:terms_conditions"`` \| \`display:main\_media:${string}\` \| ``"date_component:day"`` \| ``"date_component:month"`` \| ``"date_component:year"`` \| ``"action:allow_copy"`` \| ``"action:allow_unreplace"`` \| ``"action:allow_password_compromise_check"`` \| ``"action:client_upload"`` \| ``"action:hash"`` \| ``"action:require_webauthn"`` \| ``"action:generate_pepper:"`` \| ``"verify:show_if_pending"`` \| ``"special:hide_select_behind_button"`` \| ``"type:capture_geolocation"`` \| ``"type:extract_required"``
+
+___
+
+### SchemaName
+
+Ƭ **SchemaName**: `StringWithIdentity`<``"SchemaName"``\>
+
+A `SchemaName` is the ID of a [Schema](#schema)
 
 ___
 
 ### SchemaTag
 
-Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`time:${string}:${number}\` \| \`link\_to:${string}:${string}\` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
+Ƭ **SchemaTag**: ``"action:experimental_pass_object_store_id"`` \| ``"action:verify"`` \| \`action:display\_qr\_code:${string}:${string}\` \| ``"default_camera:rear"`` \| ``"default_camera:front"`` \| \`oauth2\_component:name:${string}\` \| \`oauth2\_component:redirect\_url:${string}\` \| \`time:${string}:${number}\` \| \`link\_to:${string}:${string}\` \| ``"display:default_view:edit"`` \| ``"type:service_provider"`` \| ``"type:service_offer"`` \| ``"type:marketplace"`` \| ``"type:client_only"`` \| ``"type:globally_unique_field"``
 
 ___
 
@@ -668,6 +931,26 @@ ___
 
 ___
 
+### Subscription
+
+Ƭ **Subscription**: [`CommonFields`](#commonfields)<[`SId`](#sid)\> & { `billing_cycle_day_of_month`: `number` \| ``null`` ; `billing_cycle_day_of_week`: `number` \| ``null`` ; `billing_cycle_hour`: `number` \| ``null`` ; `billing_cycle_minute`: `number` \| ``null`` ; `billing_cycle_month`: `number` \| ``null`` ; `billing_cycle_second`: `number` \| ``null`` ; `cancellation_effective_date`: `string` \| ``null`` ; `cancellation_final_invoice_action`: `string` ; `cancellation_request_date`: `string` \| ``null`` ; `cancellation_request_reason`: `string` \| ``null`` ; `current_billing_period_end`: `string` \| ``null`` ; `current_billing_period_start`: `string` ; `subscribed_to_customer_id`: `string` ; `subscribed_to_customer_site_id`: `string` \| ``null`` ; `subscribed_to_party_contact_point_id`: `string` ; `subscription_name`: `string` ; `subscription_name_i18n`: `string` \| ``null``  }
+
+___
+
+### SubscriptionLine
+
+Ƭ **SubscriptionLine**: [`CommonFields`](#commonfields)<[`SLId`](#slid)\> & { `billing_subscription_id`: [`SId`](#sid) ; `metadata`: `string` \| ``null`` ; `price_id`: [`PRCId`](#prcid) ; `subscribed_qty`: `number`  }
+
+___
+
+### TId
+
+Ƭ **TId**: `StringWithIdentity`<``"TId"``\>
+
+A `t_id` is the ID of a transaction
+
+___
+
 ### UId
 
 Ƭ **UId**: `StringWithIdentity`<``"UId"``\>
@@ -678,7 +961,7 @@ ___
 
 ### Urn
 
-Ƭ **Urn**: \`urn:user:${UId}\` \| \`urn:profile\_object:${NId}\` \| \`urn:instance:${IId}\` \| \`urn:temp\_object:${LId}\` \| \`urn:schema:${string}\` \| \`urn:document:${NId}\`
+Ƭ **Urn**: \`urn:user:${UId}\` \| \`urn:profile\_object:${NId}\` \| \`urn:instance:${IId}\` \| \`urn:temp\_object:${LId}\` \| \`urn:schema:${SchemaName}\` \| \`urn:document:${NId}\`
 
 e.g. "urn:user:..."
 
@@ -708,7 +991,7 @@ ___
 
 ### Verification
 
-Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](modules.md#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](modules.md#verificationpayload)<`WithValue`\> ; `hashing_algorithm?`: ``"SHA512"`` ; `key_id?`: `string` ; `key_urn?`: `string` ; `signature`: `string` ; `signing_algorithm?`: ``"RSASSA_PSS_SHA_512"``  }]  }\>
+Ƭ **Verification**<`WithValue`\>: [`ProfileObject`](#profileobject)<{ `field`: `string` ; `n_id`: [`NId`](#nid) ; `valid_until?`: `string` ; `verifications`: [{ `data`: [`VerificationPayload`](#verificationpayload)<`WithValue`\> ; `hashing_algorithm?`: ``"SHA512"`` ; `key_id?`: `string` ; `key_urn?`: `string` ; `signature`: `string` ; `signing_algorithm?`: ``"RSASSA_PSS_SHA_512"``  }]  }\>
 
 Different APIs inconsistently include the `value` prop. If you know it exists,
 use `Verification<true>`, otherwise just `Verification`. Verifications from
@@ -724,7 +1007,7 @@ ___
 
 ### VerificationPayload
 
-Ƭ **VerificationPayload**<`WithValue`\>: { `field`: `string` ; `metadata?`: { `[otherAttributes: string]`: `unknown`; `pending_details?`: { `pending_time`: ``"short"`` \| ``"long"`` ; `pending_type`: ``"time"`` \| ``"user"``  } ; `safeHarbourScore?`: [`SafeHarbourCode`](enums/SafeHarbourCode.md) ; `status?`: ``"pending"``  } ; `passed`: `boolean` ; `request_div`: `string` ; `schema?`: `string` ; `source`: `string` ; `source_hashed_n_id?`: [`NId`](#nid) ; `source_n_id?`: [`NId`](modules.md#nid) ; `type?`: ``null`` ; `v_id`: `string` ; `verification_date`: `string` ; `verifier_div`: `string` ; `verifier_id?`: [`NId`](modules.md#nid) ; `verifier_service_id?`: [`NId`](modules.md#nid) ; `verifier_source_id?`: [`NId`](modules.md#nid)  } & `WithValue` extends ``true`` ? { `value`: `string` \| `number`  } : {}
+Ƭ **VerificationPayload**<`WithValue`\>: { `field`: `string` ; `metadata?`: { `[otherAttributes: string]`: `unknown`; `pending_details?`: { `pending_time`: ``"short"`` \| ``"long"`` ; `pending_type`: ``"time"`` \| ``"user"``  } ; `safeHarbourScore?`: [`SafeHarbourCode`](enums/SafeHarbourCode.md) ; `status?`: ``"pending"`` \| ``"approved"`` ; `validation?`: { `id`: `string` ; `url`: `string`  }  } ; `passed`: `boolean` ; `request_div`: `string` ; `schema?`: [`SchemaName`](#schemaname) ; `source`: `string` ; `source_hashed_n_id?`: [`NId`](#nid) ; `source_n_id?`: [`NId`](#nid) ; `type?`: ``null`` ; `v_id`: `string` ; `verification_date`: `string` ; `verification_type_id`: [`GPMId`](#gpmid) ; `verifier_div`: `string` ; `verifier_id?`: [`NId`](#nid) ; `verifier_service_id?`: [`NId`](#nid) ; `verifier_source_id?`: [`NId`](#nid)  } & `WithValue` extends ``true`` ? { `value`: `string` \| `number`  } : {}
 
 #### Type parameters
 
@@ -747,10 +1030,17 @@ These `n_id`s point to service provider profile objects
 | `dataSourceNId?` | [`NId`](#nid) | - |
 | `date?` | `Date` | the date which the verification was verified on, or last re-verified on |
 | `serviceProviderNId?` | [`NId`](#nid) | - |
+| `verificationTypeId?` | [`GPMId`](#gpmid) | - |
 | `verifierNId?` | [`NId`](#nid) | - |
 
 ___
 
+### VerificationType
+
+Ƭ **VerificationType**: [`CommonFields`](#commonfields)<[`GPMId`](#gpmid)\> & { `asset`: `boolean` \| ``null`` ; `inventory_organization_number`: `number` \| ``null`` ; `item_description`: `string` ; `item_description_i18n`: `Json` \| ``null`` ; `item_dimension_height`: `number` \| ``null`` ; `item_dimension_length`: `number` \| ``null`` ; `item_dimension_uom`: `string` \| ``null`` ; `item_dimension_width`: `number` \| ``null`` ; `item_key`: `string` ; `item_key_01`: `string` \| ``null`` ; `item_key_02`: `string` \| ``null`` ; `item_key_03`: `string` \| ``null`` ; `item_mass`: `number` \| ``null`` ; `item_mass_uom`: `string` \| ``null`` ; `item_name`: `string` ; `item_name_i18n`: `Json` \| ``null`` ; `item_number`: `number` ; `item_type`: `string` \| ``null`` ; `item_volume`: `number` \| ``null`` ; `item_volume_uom`: `string` \| ``null`` ; `org_number`: `number` ; `primary_uom`: `string` ; `purchased`: `boolean` \| ``null`` ; `returnable`: `boolean` \| ``null`` ; `secondary_uom`: `string` \| ``null`` ; `shipped`: `boolean` \| ``null`` ; `source_organization_number`: `number` \| ``null`` ; `source_type`: `string` \| ``null`` ; `stocked`: `boolean` \| ``null`` ; `transacted`: `boolean` \| ``null``  }
+
+___
+
 ### WId
 
 Ƭ **WId**: `StringWithIdentity`<``"WId"``\>
@@ -759,6 +1049,14 @@ A `wi_id` is the ID of a [Webhook](#webhook)
 
 ___
 
+### WSId
+
+Ƭ **WSId**: `StringWithIdentity`<``"WSId"``\>
+
+A `ws_id` is the ID of a transition
+
+___
+
 ### Webhook
 
 Ƭ **Webhook**: `Object`
@@ -817,10 +1115,10 @@ in the query parameters, it needs to be base64 and/or url encoded.
 | `return_to?` | `string` | the callback url to redirect to once complete. Must be in the AA's list of authorized callback urls |
 | `review_text?` | `string` | the text on the WizardReview page |
 | `sharing_data_message?` | `string` | the loading message to show next to the spinner after the review screen |
-| `signature_schema?` | `string` | if specified, a Wizard will be shown on the review page with this schema |
+| `signature_schema?` | [`SchemaName`](#schemaname) | if specified, a Wizard will be shown on the review page with this schema |
 | `skip_share?` | `boolean` | **`Deprecated`** added in !244 but never used |
 | `submit_text?` | `string` | the submit button label |
-| `terms_schema?` | `string` | if specified, a Wizard will be shown on the review page with this schema |
+| `terms_schema?` | [`SchemaName`](#schemaname) | if specified, a Wizard will be shown on the review page with this schema |
 | `update_reference?` | `boolean` | whether the user can change the reference, if there is one in the QP |
 | `webauthn_type?` | (``"usb"`` \| ``"nfc"`` \| ``"ble"`` \| ``"internal"``)[] | if specified, the user must validate their WebAuthN credential before they can submit the form |
 
@@ -860,7 +1158,7 @@ configuration data for a single wizard page ([WizardConfig](#wizardconfig))
 | `profile?` | `boolean` | if explictly == false, then it's an AO (not a PO), in which case there can only be one schema |
 | `reverify_header?` | `string` | custom text & header that's displayed on reverfication modal for expired PO |
 | `reverify_text?` | `string` | - |
-| `schemas` | `string`[] | - |
+| `schemas` | [`SchemaName`](#schemaname)[] | - |
 | `selection_hierarchy_json?` | `string` | a URL to a preset for configuing NestedSchemaSelect. DeepConfig |
 | `service_provider_link?` | `boolean` | see #463 |
 | `share?` | ``"profile"`` \| ``"verification"`` \| ``"both"`` | the information to share. undefined implies both. |
@@ -887,8 +1185,8 @@ This is what's returned by the API
 | :------ | :------ | :------ |
 | `active` | ``true`` | - |
 | `end_date` | `string` | ISO Date. If this tag exists, the schema is deprecated. |
-| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](modules.md#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](modules.md#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](modules.md#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
-| `schema_name` | `string` | Schema Name Type and Version Properties |
+| `schema` | [`CommonSchemaAttributes`](#commonschemaattributes) & { `$id?`: `string` ; `$schema?`: `string` ; `allOf?`: { `$ref?`: `string` ; `if?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\> ; `then?`: `Partial`<[`WrappedSchema`](#wrappedschema)[``"schema"``]\>  }[] ; `definitions?`: `Record`<`string`, { `$ref`: [`Urn`](#urn)  }\> ; `properties`: { `[fieldName: string]`: [`ServerSchemaField`](#serverschemafield);  } ; `required?`: `string`[] ; `verified_fields?`: `string`[]  } | - |
+| `schema_name` | [`SchemaName`](#schemaname) | Schema Name Type and Version Properties |
 | `schema_type` | [`SchemaType`](#schematype) | - |
 | `schema_version` | `string` | - |
 | `start_date` | `string` | ISO Date |