/1/transfer/confirm

Overview

This API completes the account transfer after the user has approved it. You must obtain the confirmation code from the user after they've reviewed and confirmed the transfer on the web interface.

Endpoint

POST /1/transfer/confirm

Headers

Key	Value	Description
Authorization (Required)	Bearer <token>	Your reseller API token
Content-Type (Required)	application/json	Request content type

Key

Value

Description

Authorization

(Required)

Bearer <token>

Your reseller API token

Content-Type

(Required)

application/json

Request content type

Request Body

Field	Type	Description
email (Required)	string	Email address of the user being transferred
confirmationCode (Required)	string	10-character code provided by user (format: XXXXX-XXXXX)

Field

Type

Description

(Required)

string

Email address of the user being transferred

confirmationCode

(Required)

string

10-character code provided by user (format: XXXXX-XXXXX)

Code Example

curl -X POST "https://api.vbmappapp.com/1/transfer/confirm" \
    -H "Authorization: Bearer YOUR_RESELLER_API_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
        "email": "[email protected]",
        "confirmationCode": "K3N2P-8FG4M"
    }'

Success Response (200)

  {
      "success": true,
      "message": "Transfer completed successfully",
      "user": {
          "id": 45678,
          "email": "[email protected]",
          "firstName": "John",
          "lastName": "Doe"
      },
      "organizationNames": ["Smith Family Organization"],
      "learners": [
          {
              "id": 789,
              "code": "JANE-2010",
              "firstName": "Jane",
              "lastName": "Smith",
              "dateOfBirth": "2010-05-15",
              "assessmentIds": [123, 456],
              "purchase": {
                  "hasActivePurchase": true,
                  "beginDate": "2024-01-01",
                  "endDate": "2025-01-01",
                  "isExpired": false
              }
          },
          {
              "id": 790,
              "code": "BOB-2012",
              "firstName": "Bob",
              "lastName": "Johnson",
              "dateOfBirth": "2012-08-20",
              "assessmentIds": [789],
              "purchase": {
                  "hasActivePurchase": false,
                  "beginDate": "2023-01-01",
                  "endDate": "2024-01-01",
                  "isExpired": true
              }
          }
      ]
  }

Error Responses

Invalid Code or Email (422)

{
    "success": false,
    "error": "Invalid confirmation code or email"
}

Code Expired (422)

{
    "success": false,
    "error": "Confirmation code has expired"
}

Transfer Failed (500)

{
    "success": false,
    "error": "Transfer failed. Please try again."
}

Notes

Confirmation code is case-insensitive
Code expires after 1 hour
Transfer adds user to your reseller organization
Other users lose access to transferred organizations
User's API tokens remain valid after transfer