SYsynctera
Migration Mappings

Create a migration mapping

Changed on

Create a migration mapping that associates a resource's old tenant identity with its new tenant identity.

post/migration_mappings

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/migration_mappings
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

allow_ssn_copyboolean

When true, the vaulted SSN is copied from old_resource_id to resource_id. Only valid for resource_type PERSON: both persons must exist, their first and last names must match, the old person must have an SSN, and the new person must not already have one. The copy happens asynchronously after creation.

old_resource_idstring required

The previous resource ID under the old tenant.

old_tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

resource_idstring required

The new/current resource ID.

resource_type'ACCOUNT' | 'BUSINESS' | 'PERSON' required

The type of resource being mapped.

Example request

{
  "old_tenant": "abcdef_ghijkl"
}

Response

Migration mapping created

allow_ssn_copyboolean

When true, the vaulted SSN is copied from old_resource_id to resource_id. Only valid for resource_type PERSON. The copy happens asynchronously after creation; completion is observed by the new person having an SSN.

creation_timestring date-time required

The date and time the resource was created.

deletion_timestring date-time nullable

The date and time the resource was deleted.

idstring uuid required

The unique identifier for the migration mapping.

last_updated_timestring date-time required

The date and time the resource was last updated.

old_resource_idstring required

The previous resource ID under the old tenant.

old_tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

resource_idstring required

The new/current resource ID.

resource_type'ACCOUNT' | 'BUSINESS' | 'PERSON' required

The type of resource being mapped.

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example response

{
  "creation_time": "2010-05-06T12:23:34.321Z",
  "deletion_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "old_resource_id": "abc123",
  "old_tenant": "abcdef_ghijkl",
  "resource_id": "def456",
  "tenant": "abcdef_ghijkl"
}

Changes

  • de95e0b0874aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status