Verify the user

POST/api/v1/connected_accounts/user/verify

Confirms that the user who just authorized a connection is the user your app meant, then makes their connected account ACTIVE. When your environment verifies users with a custom verifier, Scalekit sends the user to your user_verify_url after they approve access, with an auth_request_id query parameter. Call this endpoint from your server with that auth_request_id and the identifier of the user signed in to your app, then send the user to post_user_verify_redirect_url. If the identifier doesn't match the one the authorization link was created for, the call returns 403 and the account stays PENDING_VERIFICATION.

This page as markdown Authorization overview

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

Body

auth_request_idstringrequired

The auth_request_id query parameter from the request Scalekit sent to your user_verify_url. Pass it as it is.

identifierstringrequired

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

scalekit_client.actions.verify_connected_account_user

Confirms the user who authorized is the user your app meant.

scalekit_client.actions.verify_connected_account_user(
    auth_request_id: str,
    identifier: str,
) -> VerifyConnectedAccountUserResponse

Parameters

auth_request_idstrrequired

The auth_request_id query parameter from the request Scalekit sent to your user_verify_url. Pass it as it is.

identifierstrrequired

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

Returns VerifyConnectedAccountUserResponse: The post_user_verify_redirect_url to send the user to.

From scalekit-sdk-python 2.19.1.

scalekit.actions.verifyConnectedAccountUser

Confirms the user who authorized is the user your app meant. Call it from your server when Scalekit sends the user to your userVerifyUrl, with the authRequestId from that request and the identifier of the user signed in to your app. The connected account becomes ACTIVE.

scalekit.actions.verifyConnectedAccountUser(
  params: {
    authRequestId: string;
    identifier: string;
  },
): Promise<VerifyConnectedAccountUserResponse>

Parameters

authRequestIdstringrequired

The auth_request_id query parameter from the request Scalekit sent to your user_verify_url. Pass it as it is.

identifierstringrequired

Your app's ID for the user, the same value you used when the user connected. Use a stable internal ID, not an email address.

Returns Promise<VerifyConnectedAccountUserResponse>.

From @scalekit-sdk/node 2.18.0.

Response 200

post_user_verify_redirect_urlstring

Where to send the user next, to finish connecting.

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request - missing or malformed fields

401Unauthorized - invalid or missing access token

403Forbidden - identifier mismatch

404Not found - no pending flow for the given auth_request_id or already consumed

Used in

Request

curl -sS -X POST \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/connected_accounts/user/verify" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "auth_request_id": "[AUTH REQUEST ID]",
    "identifier": "user_123"
  }'

result = scalekit_client.actions.verify_connected_account_user(
    auth_request_id="[AUTH REQUEST ID]",
    identifier="user_123",
)

const result = await scalekit.actions.verifyConnectedAccountUser({
  authRequestId: "[AUTH REQUEST ID]",
  identifier: "user_123",
});

Response 200

{
  "post_user_verify_redirect_url": "https://env1.example.com/connect/success"
}