POST
/
v1
/
accounts
/
{account_id}
/
onboard
curl --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_API_KEY' \
  --url https://sandbox.straddle.io/v1/accounts/<uuid>/onboard \
  --header 'Content-Type: application/json' \
  --data '{
  "terms_of_service": {
    "accepted_date": "2019-12-27T18:11:19.117Z",
    "agreement_url": "<string>",
    "agreement_type": "embedded"
  }
}'
{
  "meta": {
    "api_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_request_timestamp": "2023-11-07T05:31:56Z"
  },
  "response_type": "object",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "business",
    "status": "created",
    "status_detail": {
      "reason": "unverified",
      "source": "watchtower",
      "code": "<string>",
      "message": "<string>"
    },
    "business_profile": {
      "name": "<string>",
      "website": "<string>",
      "legal_name": "<string>",
      "description": "<string>",
      "use_case": "<string>",
      "tax_id": "<string>",
      "phone": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "zip": "<string>"
      },
      "industry": {
        "mcc": "<string>",
        "sector": "<string>",
        "category": "<string>"
      },
      "support_channels": {
        "email": "jsmith@example.com",
        "phone": "<string>",
        "url": "<string>"
      }
    },
    "capabilities": {
      "payment_types": {
        "charges": {
          "capability_status": "active"
        },
        "payouts": {
          "capability_status": "active"
        }
      },
      "customer_types": {
        "individuals": {
          "capability_status": "active"
        },
        "businesses": {
          "capability_status": "active"
        }
      },
      "consent_types": {
        "signed_agreement": {
          "capability_status": "active"
        },
        "internet": {
          "capability_status": "active"
        }
      }
    },
    "settings": {
      "charges": {
        "max_amount": 123,
        "monthly_amount": 123,
        "daily_amount": 123,
        "monthly_count": 123,
        "funding_time": "immediate",
        "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "payouts": {
        "max_amount": 123,
        "monthly_amount": 123,
        "daily_amount": 123,
        "monthly_count": 123,
        "funding_time": "immediate",
        "linked_bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    },
    "terms_of_service": {
      "accepted_date": "2023-11-07T05:31:56Z",
      "accepted_ip": "<string>",
      "accepted_user_agent": "<string>",
      "agreement_url": "<string>",
      "agreement_type": "embedded"
    },
    "metadata": {},
    "access_level": "standard",
    "external_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Prior to onboarding via this endpoint you must capture consent to the Straddle Payment Services Agreement (legal.straddle.io)

Authorizations

​
Authorization
string
header
required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

​
request-id
string

Optional client generated identifier to trace and debug a request.

​
correlation-id
string

Optional client generated identifier to trace and debug a series of requests.

Path Parameters

​
account_id
string
required

Body

Object containing details regarding the acceptance of the Terms of Service.

Response

201
text/plain

Created

The response is of type object.