{ "opencollection": "1.0.0", "info": { "name": "Clerk Backend Account Portal Sign Ups API", "version": "2025-11-10" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Sign Ups", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a Sign-up by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.clerk.com/v1/sign_ups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sign-up to retrieve" } ] }, "docs": "Retrieve the details of the sign-up with the given ID" }, { "info": { "name": "Update a Sign-up", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.clerk.com/v1/sign_ups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sign-up to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the sign-up with the given ID" }, { "info": { "name": "Create Sign-up", "type": "http" }, "http": { "method": "POST", "url": "https://api.clerk.com/v1/v1/client/sign_ups", "headers": [ { "name": "Origin", "value": "" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "transfer", "value": "" }, { "name": "password", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "username", "value": "" }, { "name": "email_address", "value": "" }, { "name": "phone_number", "value": "" }, { "name": "email_address_or_phone_number", "value": "" }, { "name": "unsafe_metadata", "value": "" }, { "name": "strategy", "value": "" }, { "name": "action_complete_redirect_url", "value": "" }, { "name": "redirect_url", "value": "" }, { "name": "ticket", "value": "" }, { "name": "web3_wallet", "value": "" }, { "name": "token", "value": "" }, { "name": "code", "value": "" }, { "name": "captcha_token", "value": "" }, { "name": "captcha_error", "value": "" }, { "name": "captcha_widget_type", "value": "" }, { "name": "legal_accepted", "value": "" }, { "name": "oidc_login_hint", "value": "" }, { "name": "oidc_prompt", "value": "" } ] } }, "docs": "Creates or replaces the sign-up on the current Client object." }, { "info": { "name": "Get Sign-up", "type": "http" }, "http": { "method": "GET", "url": "https://api.clerk.com/v1/v1/client/sign_ups/:sign_up_id", "params": [ { "name": "sign_up_id", "value": "", "type": "path", "description": "The sign up unique identifier." } ] }, "docs": "Returns the sign-up by ID. Must be associated with the current Client object." }, { "info": { "name": "Update Sign-up", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.clerk.com/v1/v1/client/sign_ups/:sign_up_id", "headers": [ { "name": "Origin", "value": "" } ], "params": [ { "name": "sign_up_id", "value": "", "type": "path", "description": "The sign up unique identifier." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "password", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "username", "value": "" }, { "name": "email_address", "value": "" }, { "name": "phone_number", "value": "" }, { "name": "email_address_or_phone_number", "value": "" }, { "name": "unsafe_metadata", "value": "" }, { "name": "strategy", "value": "" }, { "name": "redirect_url", "value": "" }, { "name": "action_complete_redirect_url", "value": "" }, { "name": "ticket", "value": "" }, { "name": "web3_wallet", "value": "" }, { "name": "token", "value": "" }, { "name": "code", "value": "" }, { "name": "legal_accepted", "value": "" }, { "name": "oidc_login_hint", "value": "" }, { "name": "oidc_prompt", "value": "" } ] } }, "docs": "Updates the sign-up object specified by ID, with the supplied parameters." }, { "info": { "name": "Prepare Sign-up Identification Verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.clerk.com/v1/v1/client/sign_ups/:sign_up_id/prepare_verification", "headers": [ { "name": "Origin", "value": "" } ], "params": [ { "name": "sign_up_id", "value": "", "type": "path", "description": "The sign up unique identifier." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "strategy", "value": "" }, { "name": "redirect_url", "value": "" }, { "name": "action_complete_redirect_url", "value": "" }, { "name": "oidc_login_hint", "value": "" }, { "name": "oidc_prompt", "value": "" } ] } }, "docs": "Prepares verification for the sign-up specified by `{id}`.\n\nDepending on the given strategy, the API will prepare the verification for the current sign-up.\nIn particular,\n* for `email_code`, the API will send a verification email to the email address currently load up in the sign-up\n* for `phone_code`, the API will send a verification SMS to the phone number currently load up in the sign-up\n" }, { "info": { "name": "Attempt Sign-up Identification Verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.clerk.com/v1/v1/client/sign_ups/:sign_up_id/attempt_verification", "headers": [ { "name": "Origin", "value": "" } ], "params": [ { "name": "sign_up_id", "value": "", "type": "path", "description": "The sign up unique identifier." } ], "body": { "type": "form-urlencoded", "data": [ { "name": "strategy", "value": "" }, { "name": "code", "value": "" }, { "name": "signature", "value": "" }, { "name": "token", "value": "" } ] } }, "docs": "Attempts to verify the identification that corresponds to the given strategy using the given verification code." } ] } ], "bundled": true }