v1

latestOpenAPI 3.1.02026-07-26457177.8 KB
User

Create a Business Profile for a business user

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

This endpoint creates a business profile on behalf of the business user that will be used to pre-fill the business verification forms in the Astra OAuth flow.

❗️

Note that there is a limit of 3 Business Profiles per phone number.

post/v1/business_profile

Request body

phonestring required

Phone number of the business user (format: +15557771234)

first_namestring

First name of the business user

last_namestring

Last name of the business user

emailstring

Email of the business user

user_idstring

The unique Astra user ID

kyb_type'verified' | 'unverified' | 'receive-only'

The verification type of the business user, which determines the user's capabilities to send and/or receive funds (defaults to verified if not specified)

Response

Successful response

idstring

The unique ID for the business profile to be provided as a query param in the Astra SDK