Terminology and Data Dictionary
Xpansiv Connect and Registry Data and Terminology
| Field | Type | Description |
|---|---|---|
| Account Identifier | String | The Xpansiv Connect Account ID you would like to run the API against. |
| Attributes | String | Used in the Retirement API, these attributes encompass each registry's retirement "rules" providing the user with what fields and options are required when making a retirement request. |
| Batch Identifier | String | Unique identifier associated with a batch of retirement transactions. Each Batch Identifier will contain 1 or more Retirement Identifiers. |
| Date(UTC) | String (ISO 8601 date) | YYYY-MM-DDThh:mm:ss.sss |
| EIN | String | Environment Instrument Number. Unique identifier associated with an issuance of credits from a given project, vintage, technology/fuel type and associated certification(s)/eligibility(s). An EIN is associated with a position and a position will never be associated with more than 1 EIN. |
| External Retirement Identifier | String | An optional field allowing a user to specify an identifier of their own for the purpose of the retirement. |
| Position | Double | The quantity of credits available for use in a transaction or retirement. A position can be associated with 1 or more Tax Lots. |
| Program | String | The name of the underlying registry. |
| Project Name | String | Project name as registered in the registry. |
| Project Type | String | Project type as provided by the registry. |
| Quantity | Double | The quantity of credits to be retired from a selected Tax Lot or Tax Lots. |
| Registry Assigned ID | Integer | The unique identifier in a given registry for a project. Note that the same numeric ID could occur in different registries but will be unrelated projects. To clarify this, the numeric ID is often preceded with the Program Code (e.g. CAR123 or ACR123). |
| Retirement Identifier | String | Unique identifier associated with a single retirement transaction. |
| Tax Lot | String | A Tax Lot represents the incoming activity that resulted in the creation or increase of a position against an EIN. The types of activities represented by Tax Lots are; imported positions (at account linking); incoming settled bilateral transfers; or credit issuance. Tax Lot is associated with a Position, where 1 or Tax Lots make up the available quantity for a single Position |
| Tax Lot ID | String | Unique identifier associated with each indivdiual Tax Lot |
| Tax Lot Selection Strategy | String | Where a Position has 2 or more Tax Lots, if a Tax Lot is not explicitely provided in the retirement payload, the user has the option of selecting a strategy for how Tax Lots should be selected. |
| Vintage | Integer | The vintage associated with the credits. Corelates to the timeframe within which the activity of the project occurred which then resulted in the issuance of the credits. |
| UPN | String | Universal Project Identifier. The unique identifier assigned to every resource across all registries that have integrated with Xpansiv Connect. |