v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Migration Mappings

Update migration mapping

Update specific fields of a migration mapping.

patch/migration_mappings/{mapping_id}

Path parameters

mapping_idstring uuid required

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

The unique identifier for the migration mapping.

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

old_resource_idstring

The previous resource ID under the old tenant.

old_tenantstring

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

resource_idstring

The new/current resource ID.

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

The type of resource being mapped.

Example request

{
  "old_tenant": "abcdef_ghijkl"
}

Response

Updated migration mapping

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"
}