This document is generated by Aladia.

Become a Teacher

Developing

POST

/profiles/teachers

This endpoint updates the profile type to "teacher", creates a Connect account for the teacher, and returns the onboarding URL.
For guidance on using the client secret, refer to:
https://docs.stripe.com/connect/custom/hosted-onboarding

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.aladia.io/v2/profiles/teachers?limit=50&next=&prev=&sortBy=&sortDirection=asc&query=' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "Pakistan"
}'

Response Example

201 - Success

{
  "ownerId": "6664875f427d21851ad83798",
  "onboardUrl": "https://gloomy-detainee.com",
  "expiresAt": -22033571.380516425
}

Request

Query Params

limit

integer

optional

Number of documents per page in the response

Default:

string

optional

Next token cursor, to navigate towards the next page

string

optional

Previous token cursor, to navigate towards the previous page

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

query

string

optional

The search query string.

Header Params

apikey

string

optional

Example:

Body Params application/json

country

object

optional

The account’s country.

alpha2Code

string

required

Country Code

name

string

required

Examples

Responses

🟢201Created

application/json

Body

ownerId

string

optional

Example:

6664875f427d21851ad83798

onboardUrl

string

optional

expiresAt

number

optional

clientSecret

string | null

optional

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-04-09 13:03:28

Unread Count