Ashley DeBon: /* Sign Up with Microsoft */

2026-07-20T05:22:47Z

‎Sign Up with Microsoft

Ashley DeBon: Created page with "== Sign Up with Microsoft == === Base URL === https://apimobile.callproof.com === Endpoint === /api/microsoft-register === Purpose === Creates a CallProof account using a v..."

2026-07-15T07:41:30Z

Created page with "== Sign Up with Microsoft == === Base URL === https://apimobile.callproof.com === Endpoint === /api/microsoft-register === Purpose === Creates a CallProof account using a v..."

New page

== Sign Up with Microsoft ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/microsoft-register

=== Purpose ===
Creates a CallProof account using a verified Microsoft identity and immediately provides authenticated access.

'''Important:''' This API is exclusively for users signing up or continuing with a Microsoft account.

For a new Microsoft email address, the API creates a company workspace and administrator account using profile information supplied by Microsoft. The workspace receives CallProof's standard settings, permissions, dashboard options, contact categories, opportunity stages, event forms, and other default business configuration.

If the Microsoft email already belongs to a CallProof user, a duplicate account is not created. The existing account is used and authenticated access is returned.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Content-Type || Yes || <code>application/x-www-form-urlencoded</code> or <code>application/json</code>
|}

=== Security ===
* '''No''' – No prior CallProof authentication is required. Valid Microsoft authentication credentials must be supplied.

=== Parameters ===
==== Microsoft Authentication Fields ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| access_token || string || Yes || A valid Microsoft access token used to retrieve and verify the user's Microsoft identity.
|-
| token || string || Yes || The Microsoft identity token associated with the sign-up session.
|-
| device_type || string || Yes || The mobile platform requesting registration. Accepted values are <code>android</code> and <code>ios</code>.
|-
| refresh_token || string || No || A Microsoft refresh token used to maintain access to connected Microsoft services. Supplying this value is recommended.
|-
| expires_in || integer || No || The number of seconds before the Microsoft access token expires. Supplying this value is recommended.
|}

==== General Device Fields ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| device_id_app || string || No || The device notification token used for notifications and device recognition.
|-
| device_time_zone || string || No || The device's time-zone identifier, such as <code>America/Chicago</code>. When omitted, a time zone may be determined automatically.
|-
| cp_version || string || No || The installed CallProof application version.
|-
| product || string || No || The device product or model identifier.
|-
| resolution || string || No || The device screen resolution.
|-
| device_name || string || No || The user-visible device name.
|-
| is_tablet || boolean || No || Indicates whether the device is a tablet.
|}

==== Android Device Fields ====
These fields apply when <code>device_type</code> is <code>android</code>.

{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| android_version || string || No || The Android operating-system version.
|-
| android_api_version || string || No || The Android API version.
|-
| android_apk_version || string || No || The installed Android application package version.
|-
| is_callLog_build || boolean || No || Indicates whether the Android application supports call-log capabilities.
|}

==== iOS Device Fields ====
This field applies when <code>device_type</code> is <code>ios</code>.

{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| ios_version || string || No || The iOS operating-system version.
|}

=== Successful Response (200) ===
The Microsoft identity was verified and authenticated access credentials were issued.

For a new Microsoft user, a CallProof company and administrator account were created. For an existing user, the matching CallProof account was used without creating a duplicate.

{| class="wikitable"
! Response Field !! Type !! Description
|-
| clientStatusCode || integer || Business-level response status. A successful request returns <code>200</code>.
|-
| data.token_type || string || The authentication token type, normally <code>Bearer</code>.
|-
| data.expires_in || integer || The CallProof access token validity period.
|-
| data.access_token || string || The credential used to access authenticated CallProof API endpoints.
|-
| data.refresh_token || string || The credential used to obtain a new CallProof access token.
|-
| data.is_2fa_enabled || boolean || Indicates whether two-factor authentication is enabled for the user or company.
|-
| data.is_verified || boolean || Indicates whether the applicable two-factor authentication requirement has been satisfied.
|-
| data.email || string || The email address obtained from the verified Microsoft identity.
|-
| uri || string || The URL of the Microsoft registration request.
|}

=== Error Responses ===
Microsoft registration failures are generally returned with HTTP status <code>200</code>. The business-level result is supplied through <code>clientStatusCode</code>.

{| class="wikitable"
! HTTP Status Code !! Client Status Code !! Meaning
|-
| 200 || 401 || The required <code>access_token</code> field was not supplied.
|-
| 200 || 401 || The required <code>token</code> field was not supplied.
|-
| 200 || 401 || The required <code>device_type</code> field was not supplied.
|-
| 200 || 400 || The device type is not <code>android</code> or <code>ios</code>.
|-
| 200 || 400 || The Microsoft access token is invalid, expired, or could not be verified.
|-
| 200 || 400 || Microsoft did not provide sufficient identity information.
|-
| 200 || 400 || The Microsoft authentication credentials could not be stored.
|-
| 200 || 400 || The CallProof account or company workspace could not be created.
|-
| 200 || 400 || Device information could not be associated with the account.
|-
| 200 || 400 || Microsoft signup could not be completed.
|}

==== Error Response Fields ====
{| class="wikitable"
! Response Field !! Type !! Description
|-
| clientStatusCode || integer || The business-level error status, typically <code>400</code> or <code>401</code>.
|-
| error.code || integer || The business error code, generally <code>1500</code>.
|-
| error.message || string || A plain-language explanation of the Microsoft registration failure.
|-
| uri || string || The URL of the Microsoft registration request.
|}

← Older revision		Revision as of 05:22, 20 July 2026
Line 1:		Line 1:
−	== Sign Up with Microsoft ==	+	==[[Mobile_API]] » Sign Up with Microsoft ==

	=== Base URL ===		=== Base URL ===

Microsoft User Register - Revision history

Ashley DeBon: /* Sign Up with Microsoft */

Ashley DeBon: Created page with "== Sign Up with Microsoft == === Base URL === https://apimobile.callproof.com === Endpoint === /api/microsoft-register === Purpose === Creates a CallProof account using a v..."