Models
Participant Migration
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the migration record. Example: "pm_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
companyId | string | Yes | The ID of the company the identifier belongs to. Example: "c_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
scheme | string | Yes | The scheme of the identifier being migrated. Example: "0208" |
identifier | string | Yes | The value of the identifier being migrated. Example: "1012081766" |
direction | inbound | outbound | Yes | inbound moves the identifier from another provider to Recommand, outbound moves it away from Recommand. Values: inbound, outbound |
status | pending | inProgress | completed | cancelled | failed | Yes | pending: the key is stored and is used as soon as the company is registered in the SMP, which for teams with strict verification is when the company passes its identity check. inProgress: an outbound key was issued and the receiving provider has not claimed the identifier yet. completed: the identifier moved. failed: the SML refused the key; see errorMessage. Values: pending, inProgress, completed, cancelled, failed |
migrationKey | string | Yes | The migration key. For an outbound migration this is the key to hand to the new provider |
errorMessage | string | null | Yes | Why the migration failed or was cancelled, when it did |
createdAt | string (date-time) | Yes | Format: date-time |
completedAt | string | null | Yes | When the migration reached a final status. Format: date-time |