Onboard Business

Developing

POST

/user/signup

Create a user, link it to a business's website and get it's iframe link.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.inboundiq.ai/api/v1/user/signup' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "john.doe@exmaple.com",
    "firstName": "John",
    "lastName": "Doe",
    "websiteUrl": "https://example.com"
}'

Response Example

{
    "status": 200,
    "message": "User verified successfully, checking for website eligibility",
    "data": {
        "userId": "usr_9180b333-4874-4785-a380-a62d626b55fc"
    }
}

Modified at 2025-12-12 13:08:38

Get User

Authenticate User