Brein API

Auth

Send verification code

POST

/api/v1/auth/send/code

Send a verification code to the provided phone number

Send verification code › Request Body

phonestring · required
Phone

Send verification code › Responses

Code sent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/send/code

curl --request POST \
  --url /api/v1/auth/send/code \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone"
}

json

Example Responses

No example

json

application/json

Verify code

POST

/api/v1/auth/verify/code

Verify the code sent to the phone number

Verify code › Request Body

phonestring · required
Phone
codestring · required
Code

Verify code › Responses

Code verified

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/verify/code

curl --request POST \
  --url /api/v1/auth/verify/code \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone",
  "code": "code"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone",
  "code": "code"
}

json

Example Responses

No example

json

application/json

Verify phone number

POST

/api/v1/auth/verify/phone

Verify a phone number

Verify phone number › Request Body

phonestring · required
Phone

Verify phone number › Responses

Phone verified

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/verify/phone

curl --request POST \
  --url /api/v1/auth/verify/phone \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone"
}

json

Example Responses

No example

json

application/json

Legal Documents Pending (Task)

Brein API

Auth

Send verification code

POST

/api/v1/auth/send/code

Send a verification code to the provided phone number

Send verification code › Request Body

phonestring · required
Phone

Send verification code › Responses

Code sent

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/send/code

curl --request POST \
  --url /api/v1/auth/send/code \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone"
}

json

Example Responses

No example

json

application/json

Verify code

POST

/api/v1/auth/verify/code

Verify the code sent to the phone number

Verify code › Request Body

phonestring · required
Phone
codestring · required
Code

Verify code › Responses

Code verified

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/verify/code

curl --request POST \
  --url /api/v1/auth/verify/code \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone",
  "code": "code"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone",
  "code": "code"
}

json

Example Responses

No example

json

application/json

Verify phone number

POST

/api/v1/auth/verify/phone

Verify a phone number

Verify phone number › Request Body

phonestring · required
Phone

Verify phone number › Responses

Phone verified

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
codestring · required
2FA Code
expirationDatestring · required
Expiration date

POST /api/v1/auth/verify/phone

curl --request POST \
  --url /api/v1/auth/verify/phone \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "phone"
}
'

shell

Show example in

Request Body Example

{
  "phone": "phone"
}

json

Example Responses

No example

json

application/json

Legal Documents Pending (Task)