Skip to Content
Apex Settlement
Onboarding

Save the Compliance Profile draft

Required permissioncustomer:profile:write
PUT
/v1/profile

Replaces the draft with data: business for a business Customer, individual for an individual one. A draft may be incomplete; nothing is judged until it is submitted. Refused once the profile is submitted, unless Compliance sends it back.

Requires the customer:profile:write permission. A Platform may call it for one of its End Customers with Apex-End-Customer.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Header Parameters

Apex-End-Customer?string

A Platform acting for one of its End Customers names it here: the request then reads and changes that End Customer's resources, under the API key's own permissions. Leave it out to act for the Platform itself. An id that is not one of the caller's End Customers answers end_customer_not_found.

Formatuuid

Request Body

The draft.

application/json
  1. body
data?

Response Body

OK

application/json
  1. response
data*
request_note?string
requested_fields*array<string>
submitted_at?string
Formatdate-time
version*integer
Example Request
curl -X PUT 'http://localhost:3480/v1/profile' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "business": {      "address": {        "city": "New York",        "country": "US",        "line1": "350 Fifth Avenue",        "line2": "Suite 4100",        "postal_code": "10118",        "region": "NY"      },      "authorised_persons": [        {          "email": "tom@example.com",          "name": "Tom Becker",          "role": "Director"        }      ],      "control_persons": [        {          "address": {            "city": "New York",            "country": "US",            "line1": "350 Fifth Avenue",            "line2": "Suite 4100",            "postal_code": "10118",            "region": "NY"          },          "date_of_birth": "1985-04-12",          "name": "Tom Becker",          "nationality": "US",          "tax_id": "string",          "title": "Managing Director"        }      ],      "corridors": [        "US-DE",        "US-PK"      ],      "date_established": "2019-03-01",      "entity_type": "corporation",      "expected_monthly_volume": {        "amount": "1000",        "asset": "USDC"      },      "legal_name": "Becker Trading LLC",      "phone": "+12125550100",      "registration_number": "7712345",      "tax_id": "string",      "ubos": [        {          "address": {            "city": "New York",            "country": "US",            "line1": "350 Fifth Avenue",            "line2": "Suite 4100",            "postal_code": "10118",            "region": "NY"          },          "country": "US",          "date_of_birth": "1985-04-12",          "name": "Tom Becker",          "nationality": "US",          "share_percent": "100"        }      ],      "website": "https://becker-trading.example.com"    },    "individual": {      "address": {        "city": "New York",        "country": "US",        "line1": "350 Fifth Avenue",        "line2": "Suite 4100",        "postal_code": "10118",        "region": "NY"      },      "date_of_birth": "1985-04-12",      "full_name": "Tom Becker",      "nationality": "US"    }  },  "request_note": "Please upload a proof of address dated within three months.",  "requested_fields": [    "individual.address.line1"  ],  "submitted_at": "2026-11-10T16:45:00Z",  "version": 1}