How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Socotra

Socotra Migration API

The Migration API from Socotra — 12 operation(s) for migration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Socotra Migration API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Migration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 12 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

13 operations 12 paths 36 schemas 7 GET4 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
View terms
Resource Areas
1

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 7 GET, 4 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Migration 13
POST
/migration/{tenantLocator}/migrations
startMigration 2 params body → 200
POST
/migration/{tenantLocator}/migrations/accounts/{accountLocator}
startMigrationForAccount 3 params body → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}
getMigrationSummary 2 params → 200
PATCH
/migration/{tenantLocator}/migrations/{migrationLocator}
patchMigration 2 params body → 200
PATCH
/migration/{tenantLocator}/migrations/{migrationLocator}/resume
resumeMigration 2 params → 200
PATCH
/migration/{tenantLocator}/migrations/{migrationLocator}/recover
recoverMigration 2 params → 200
PATCH
/migration/{tenantLocator}/migrations/{migrationLocator}/pause
pauseMigration 2 params → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}/mappings/list
Returns per-account mappings of system locators to original IDs
getMigrationMappings 4 params → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}/failures/list
getMigrationFailures 4 params → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}
getAccountMigrations 3 params → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}/accounts/{accountLocator}/mappings
Fetches mappings of original IDs to system locators for an account
getMigrationMappingsForAccount 3 params → 200
GET
/migration/{tenantLocator}/migrations/{migrationLocator}/accounts/list
listAccountMigrations 4 params → 200
GET
/migration/events
fetchMigrationEventDefinitions → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are PolicyMigrationRequest (14 properties), MigrationInstallmentPreferences (13 properties), AccountMigrationData (11 properties), InvoiceMigrationRequest (8 properties). Each schema is shown below with its type and property counts.

ListPageResponseAccountMigrationIdMappings
object
2 properties 2 required
AccountMigrationResponse
object
6 properties 5 required
AccountingMigrationRequest
object
1 property 1 required
InstallmentItemMigrationRequest
object
3 properties 3 required
InvoiceMigrationRequest
object
8 properties 5 required
MigrationEvents
object
8 properties
SegmentMigrationRequest
object
3 properties 3 required
AccountMigrationIdMappingsResponse
object
7 properties 7 required
AuxDataMigrationRequest
object
2 properties 2 required
AccountMigrationData
object
11 properties 4 required
CreditItemMigrationRequest
object
1 property 1 required
MigrationEventData
object
1 property 1 required
DisbursementMigrationRequest
object
6 properties 5 required
PolicyMigrationRequest
object
14 properties 7 required
MigrationPreferences
object
1 property
MigrationServiceEventTypeDefinitions
object
1 property 1 required
ElementMigrationRequest
object
6 properties 6 required
PatchAccountMigrationRequest
object
7 properties 6 required
MappingObject
object
3 properties 3 required
PaymentMigrationRequest
object
7 properties 5 required
PaymentItemMigrationRequest
object
2 properties 2 required
TransactionMigrationRequest
object
7 properties 5 required
MigrationResponse
object
4 properties 4 required
ListPageResponseAccountMigrationResponse
object
2 properties 2 required
MigrationRequest
object
5 properties 5 required
ErrorDetailsResponse
object
2 properties 2 required
AccountMigrationRequest
object
7 properties 7 required
ListPageResponseMigrationFailuresResponse
object
2 properties 2 required
InstallmentMigrationRequest
object
5 properties 5 required
ChargeMigrationRequest
object
5 properties 5 required
TermMigrationRequest
object
3 properties 3 required
MigrationFailuresResponse
object
7 properties 6 required
AuxDataEntryMigrationRequest
object
2 properties 2 required
ValidationItemResponse
object
3 properties 3 required
ValidationResult
object
2 properties 1 required
MigrationInstallmentPreferences
object
13 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-migration-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
AE Profile APIs.io
Socotra Auxdata API
AE Profile APIs.io
Socotra Billing API
AE Profile APIs.io
Socotra Business Stats API
AE Profile APIs.io
Socotra Claim API
AE Profile APIs.io
Socotra Compliance API
AE Profile APIs.io
Socotra Config API
AE Profile APIs.io
Socotra Contact API
AE Profile APIs.io
Socotra Document API
AE Profile APIs.io
Socotra Event API
AE Profile APIs.io
Socotra Payment Execution API
AE Profile APIs.io
Socotra Plugin API
AE Profile APIs.io
#Migration
← Back to S APIs
API Details
ID
socotra:socotra-migration-api
Base URL
https://api.sandbox.socotra.com
Docs
https://docs.socotra.com/docs/api
Provider
Socotra
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=socotra-migration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/socotra-migration-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Socotra Migration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.