Bulk migration examples and data schemas

Strivacity offers robust support for migrating customers from external applications through custom database connections via the Strivacity API. This flexible and efficient approach ensures seamless integration and transition of customer data from various external systems into the Strivacity platform, enhancing the overall experience.

Account API endpoints

The Strivacity platform offers numerous API endpoints to facilitate customer migration and other customer account operations. Our APIs are RESTful and use a JSON data structure.

Please note that the Strivacity APIs have a default rate limit applied to all endpoints. We can increase this limit upon request; please contact our support team for assistance.

For large-scale transfers (100,000+ customers), our integration engineers can assist you with the bulk import process.

Customer account data schema

{
  "accountInfo": {
    "additionalProp": {}
  },
  "accountLockout": {
    "lockoutUntil": "2024-07-04T13:32:16.911Z"
  },
  "accountProofings": [
    {
      "attempts": 0,
      "deleted": true,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invalidatedAt": "2024-07-04T13:32:16.911Z",
      "policyId": "string",
      "policyName": "string",
      "proofedAt": "2024-07-04T13:32:16.911Z"
    }
  ],
  "authenticators": {
    "methods": [
      {
        "id": "string",
        "methods": "passcode",
        "target": "+36301234567",
        "type": "password"
      }
    ]
  },
  "consents": [
    {
      "consentId": "string",
      "consentVersion": 0,
      "id": "string",
      "optIn": "2024-07-04T13:32:16.911Z",
      "optOut": "2024-07-04T13:32:16.911Z"
    }
  ],
  "createdAt": "2024-07-04T13:32:16.911Z",
  "enabled": true,
  "groups": [
    {
      "id": "string"
    }
  ],
  "id": "string",
  "identities": {
    "additionalProp": {}
  },
  "language": "string",
  "lastLogin": {
    "ip": "string",
    "location": {
      "geometry": {
        "coordinates": [
          0
        ],
        "type": "string"
      },
      "properties": {
        "additionalProp": "string"
      },
      "type": "string"
    },
    "time": "2024-07-04T13:32:16.911Z"
  },
  "numberOfLogins": 0,
  "organization": "string",
  "roles": [
    {
      "id": "string",
      "organization": "string"
    }
  ],
  "store": "string",
  "updatedAt": "2024-07-04T13:32:16.911Z"
}

Main properties

Property	Type	Required	Description	Sample
username	string	yes	The unique identifier for the customer within the Strivacity system.	[email protected] UserName
email	string	yes	The customer's email address, used for communication and login.	[email protected]
password	string	yes	The password for the customer's account, adhering to Strivacity's policy.	PassWord12 $2a$10$.8ccunTxxy9UTNGs
phone_number	string	no	The customer's phone number, recommended for Multi-Factor Authentication (MFA).	+18447825486
first_name	string	no	The customer's first name.	John
last_name	string	no	The customer's last name.	Doe
roles	array	no	Roles assigned to the customer, defining their permissions.	{ "roles": [ { "id": "role1", "name": "Admin" }, { "id": "role2", "name": "Editor" } ] }
custom_attributes	object	no	Custom attributes specific to the organization’s requirements.	N/A
address	object	no	The customer's address, consists of street, city, state, postal code, and country.	{ "address": { "street": "205 Van Buren Street Suite 120", "city": "Herndon", "state": "VA", "postal_code": "20170", "country": "USA" } }
date_of_birth	string	no	The customer's date of birth in the YYYY-MM-DD format.	1999-09-09
mfa_enabled	boolean	no	Indicates if MFA is enabled for the customer.	false
status	string	no	The status of the customer's account, such as active, suspended, or deactivated.	active
language	string	no	The preferred language for the customer.	EN_US
organization_id	string	no	Identifier for the organization the customer belongs to.	dc3228b1-c342-4248-a4c1-236f24cb61df
consent_provided	boolean	no	Indicates if consent has been provided.	true
email_verified	boolean	no	Indicates if the customer's email address has been verified.	true
phone_verified	boolean	no	Indicates if the customer's phone number has been verified.	false
created_at	string	no	Timestamp of when the account was created.	2023-07-23T15:30:00Z
updated_at	string	no	Timestamp of the last update to the account.	2023-07-23T15:30:00Z
app_metadata	object	no	Application-specific metadata.	N/A
user_metadata	object	no	Customer-specific metadata.	N/A
email_confirmed	boolean	no	Indicates if the customer's email is confirmed.	true

Address attributes

This table details the nested attributes for the address property within a customer's account. Each attribute defines a specific aspect of the customer's address, providing a comprehensive structure to store the customer's location information.

Property	Type	Required	Description
street	string	no	The street address of the customer.
city	string	no	The city of the customer's address.
state	string	no	The state of the customer's address.
postal_code	string	no	The postal code of the customer's address.
country	string	no	The country of the customer's address.

Metadata attributes

These are the nested attributes for both app_metadata and user_metadata. These attributes encompass custom key-value pairs that are specific to the application and the customer, allowing for the storage of additional metadata that enhances the customer's interaction and personalization within the application.

Property	Type	Required	Description
app_specific_key	string	no	Custom key-value pairs specific to the app.
user_specific_key	string	no	Custom key-value pairs specific to the customer.

📘
Use our Import validator tool to ensure that your bulk migration file is ready to import into your Strivacity instance.