API Overview

Base URLs

Environment	Base URL
Sandbox	`https://m2m-backend-qa.up.railway.app`

Always use the sandbox environment for development and testing.

Authentication

All API requests require authentication via the X-API-Key header:

curl -X POST https://m2m-backend-qa.up.railway.app/partner/links \
  -H "X-API-Key: m2m_test_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"referenceId": "user_123"}'

string

required

Your API key. Use m2m_test_* for sandbox.

string

required

Must be application/json for all POST/PUT requests.

See the Authentication guide for details on managing API keys.

Response format

All successful responses follow this structure:

{
  "success": true,
  "data": {
    // Response data varies by endpoint
  }
}

boolean

required

Always true for successful responses.

object

required

The response payload. Structure varies by endpoint.

Error responses

When an error occurs, the response includes an error code and message:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The referenceId field is required"
  }
}

boolean

required

Always false for error responses.

object

required

Error details.

Show Error properties

string

required

Machine-readable error code.

string

required

Human-readable error description.

HTTP status codes

Status	Description
`200`	Success
`201`	Created (for POST requests that create resources)
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Valid key but insufficient permissions
`404`	Not Found - Resource doesn’t exist
`409`	Conflict - Resource already exists (e.g., active link for user)
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error

Common error codes

Code	Description
`UNAUTHORIZED`	Missing or invalid authentication
`INVALID_API_KEY`	API key is invalid or revoked
`PARTNER_SUSPENDED`	Partner account is suspended
`INVALID_REQUEST`	Request validation failed
`RESOURCE_NOT_FOUND`	Requested resource doesn’t exist
`ACTIVE_LINK_EXISTS`	User already has an active link
`LINK_EXPIRED`	Magic link has expired
`REFERENCE_ID_MISMATCH`	Reference ID doesn’t match

Rate limiting

The API enforces rate limits to ensure fair usage:

Endpoint	Limit
Create Link	100 requests/minute
Other endpoints	1000 requests/minute

When you exceed the rate limit, you’ll receive a 429 Too Many Requests response:

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please retry after 60 seconds."
  }
}

Implement exponential backoff in your integration to handle rate limiting gracefully.

Pagination

List endpoints support pagination using limit and offset parameters:

integer

default:"20"

Maximum number of results to return. Range: 1-100.

integer

default:"0"

Number of results to skip for pagination.

Paginated responses include metadata:

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "total": 150,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

Idempotency

For POST requests, you can include an Idempotency-Key header to ensure the request is processed only once:

curl -X POST https://m2m-backend-qa.up.railway.app/partner/links \
  -H "X-API-Key: m2m_test_your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: unique-request-id-12345" \
  -d '{"referenceId": "user_123"}'

If you retry a request with the same Idempotency-Key, you’ll receive the same response as the original request.

Available endpoints

Create Link

Generate a magic link for your user.

Overview

Endpoints

Partner - Magic Links

Partner - Users

Partner - Data Requests

Partner - Webhooks

Partner - Settings

Partner - Operations

Partner - CIP

Base URLs

Authentication

Response format

Error responses

HTTP status codes

Common error codes

Rate limiting

Idempotency

Available endpoints

Create Link

​Base URLs

​Authentication

​Response format

​Error responses

​HTTP status codes

​Common error codes

​Rate limiting

​Pagination

​Idempotency

​Available endpoints

Create Link

Base URLs

Authentication

Response format

Error responses

HTTP status codes

Common error codes

Rate limiting

Pagination

Idempotency

Available endpoints