KYC Prefill

Confirm KYC prefill data on an account. When you create an account using prefill (Prove live data or sandbox seed data), the account holder must confirm the prefilled identity information before Frame treats it as verified. This endpoint records that confirmation along with the caller's IP and user-agent as evidence of consent, and emits the frame.account.prefill.completed event.

Confirm KYC prefill

Records the account holder's confirmation of the KYC prefill data attached to an account. Use this endpoint at the end of a prefill flow — after Frame has populated the account holder's identity information from Prove (live mode) or from sandbox seed data — to mark that prefilled data as confirmed by the end user.

The caller's IP address and user-agent are captured from the HTTP request as evidence of consent and stored on the account's individual record. On the first successful call, Frame emits the frame.account.prefill.completed webhook event; subsequent calls are idempotent and do not re-emit.

Returns the updated account, including its current capabilities and any outstanding step fields. Returns 422 if the account does not have a KYC prefill record ready to confirm (e.g. prefill was never run, or the prefilled record is not in a confirmable state).

Path parameters
account_idstringrequired

ID of the account whose KYC prefill is being confirmed.

Returns

Prefill confirmed. The account holder's prefilled identity is now linked to the account.

POST/v1/accounts/{account_id}/kyc_prefill/confirm
curl --request POST \
  --url https://api.framepayments.com/v1/accounts/a70cd72f-e74a-40f2-96a2-3f60714aac4a/kyc_prefill/confirm \
  --header 'Authorization: Bearer API_KEY'
RESPONSE
{
  "id": "00000000-0000-4000-8000-000000000001",
  "status": "pending",
  "external_id": null,
  "metadata": {},
  "payout_payment_method_id": null,
  "type": "individual",
  "object": "account",
  "terms_of_service": null,
  "profile": {
    "individual": {
      "email": "paulette@fritsch-graham.test",
      "ssn_last_four": null,
      "name": {
        "first_name": "Jason",
        "middle_name": null,
        "last_name": "Brakus",
        "suffix": null
      },
      "phone": {
        "number": null,
        "country_code": null
      },
      "address": null,
      "birthdate": null
    }
  },
  "capabilities": [],
  "created": 1745107200,
  "updated": 1745107200,
  "livemode": false
}