Skip to main content
POST
/
migration_mappings
Create a migration mapping
curl --request POST \
  --url https://api.synctera.com/v2/migration_mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "old_resource_id": "<string>",
  "old_tenant": "abcdef_ghijkl",
  "resource_id": "<string>"
}
'
{
  "creation_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",
  "deletion_time": "2010-05-06T12:23:34.321Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Migration mapping to create

Fields required to create a migration mapping.

​
old_resource_id
string
required

The previous resource ID under the old tenant.

​
old_tenant
string
required

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

Example:

"abcdef_ghijkl"

​
resource_id
string
required

The new/current resource ID.

​
resource_type
enum<string>
required

The type of resource being mapped.

Available options:
PERSON,
BUSINESS,
ACCOUNT

Response

Migration mapping created

Maps a resource identity from an old tenant to a new tenant.

​
creation_time
string<date-time>
required

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

The unique identifier for the migration mapping.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_updated_time
string<date-time>
required

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
old_resource_id
string
required

The previous resource ID under the old tenant.

Example:

"abc123"

​
old_tenant
string
required

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

Example:

"abcdef_ghijkl"

​
resource_id
string
required

The new/current resource ID.

Example:

"def456"

​
resource_type
enum<string>
required

The type of resource being mapped.

Available options:
PERSON,
BUSINESS,
ACCOUNT
​
tenant
string
required

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

Example:

"abcdef_ghijkl"

​
deletion_time
string<date-time> | null

The date and time the resource was deleted.

Example:

"2010-05-06T12:23:34.321Z"