Integration Shape
From first request to live workflow.
These examples show the shape of a typical integration. Use the maintained documentation and API reference for current fields, schemas, and requirements.
Provisioning
Create an account
Provision a challenge account from your checkout, CRM, or internal operations tooling.
curl https://api.yourpropfirm.com/v1/accounts \
-H "Authorization: Bearer $YPF_SECRET_KEY" \
-d challenge=ch_2ev_100k_2step \
-d trader[email]="jordan@example.com" \
-d platform=mt5
Risk events
React to a rule breach
Receive signed events when account, risk, KYC, or payout state changes.
{
"type": "account.rule_fired",
"data": {
"account": "acc_7fK3xT",
"rule": "max_daily_drawdown",
"severity": "hard"
}
}
Payouts
Automate an approval
Connect your own approval workflow while keeping every state change traceable.
const payout = await ypf.payouts.create({
account: "acc_7fK3xT",
amount: 240000,
currency: "USD"
});