Verify Organization - Aladia API

This endpoint verifies an organization by adding details.

curl --location --request PATCH 'https://api.aladia.io/v2/organizations//verification' \ --header 'apikey: ' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "string", "domain": "string", "country": { "name": "string", "alpha2Code": "string" }, "pictureUrl": "string" }'

{ "id": "3bdaddc6ad5cde8f3c4c808b", "name": "string", "bio": "string", "description": "string", "contactsVisibility": { "email": true, "phoneNumber": true, "sites": true, "birthDate": true }, "stripeConnectOnboard": "completed", "phoneNumber": "string", "email": "string", "socialLinks": [ { "platform": "string", "displayText": "string", "url": "string", "show": true } ], "sites": [ { "streetAddress": "string", "city": "string", "state": "string", "country": "string", "zipCode": "string", "formattedAddress": "string", "streetNumber": 0, "lat": 0, "lng": 0, "isHeadQuarter": true, "timezone": "string", "name": "string", "organizationPageLink": "string" } ], "status": "string", "picture": "string", "cover": "string", "setupProcess": { "step": 0, "section": 0 }, "review": { "totalReviews": 0, "globalRating": 0, "ratings": [ { "star": 0, "count": 0, "percentage": 0 } ] }, "domain": "string", "settings": { "theme": "dark", "language": "string", "autoPost": true }, "completion": 0, "branches": [ { "id": "string", "status": "active" } ], "createdAt": "2019-08-24", "updatedAt": "2019-08-24", "owner": { "id": "670775694daebf393b266ea1", "username": "string", "firstName": "string", "lastName": "string", "email": "user@example.com", "phoneNumber": "string", "numberOf": { "followers": 0, "followings": 0, "reviews": 0, "posts": 0, "solved": 0 } }, "followers": [ { "id": "6660c7e81f0e3b1cf2c7d687", "type": "user", "story": { "status": "active", "nextStoryId": "string" }, "entityType": "profile", "name": "string", "picture": "string", "createdAt": "string", "lastActivity": "string", "mainExperience": "string", "bio": "string" } ], "following": [ { "id": "6660c7e81f0e3b1cf2c7d687", "type": "user", "story": { "status": "active", "nextStoryId": "string" }, "entityType": "profile", "name": "string", "picture": "string", "createdAt": "string", "lastActivity": "string", "mainExperience": "string", "bio": "string" } ], "members": [ { "id": "670775694daebf393b266ea1", "status": "pending", "profile": { "id": "670775694daebf393b266ea1", "username": "string", "firstName": "string", "lastName": "string", "picture": "string", "email": "user@example.com", "type": "user", "address": { "streetAddress": "string", "city": "string", "state": "string", "country": "string", "zipCode": "string", "formattedAddress": "string", "lat": "string", "lon": "string" }, "lastActivity": "string", "online": true }, "organization": { "id": "670775694daebf393b266ea1", "name": "string", "sites": [ { "streetAddress": "string", "city": "string", "state": "string", "country": "string", "zipCode": "string", "formattedAddress": "string", "streetNumber": 0, "lat": 0, "lng": 0, "isHeadQuarter": true, "timezone": "string", "name": "string", "organizationPageLink": "string" } ], "picture": "string", "branches": [ { "id": "string", "status": "active" } ] }, "role": "organization-owner", "invited": true, "invitedAt": "2019-08-24", "secondaryRoles": [ "string" ], "expiresAt": "string" } ], "industry": { "id": "string", "name": "string", "language": "string" }, "entityType": "profile", "accountlink": { "ownerId": "6664875f427d21851ad83798", "onboardUrl": "string", "expiresAt": 0, "clientSecret": "string" } }

Request

Path Params

organizationId

string

required

Header Params

apikey

string

optional

Example:

Body Params application/json

name

string

optional

domain

string

required

country

object

required

name

string

required

alpha2Code

string

required

pictureUrl

string

optional

Examples

Responses

🟢200Success

application/json

Body

string <uuid>

optional

Example:

3bdaddc6ad5cde8f3c4c808b

name

string

optional

name of company

bio

string | null

optional

bio of the organization

description

string | null

optional

description of the organization

contactsVisibility

object (contactsVisibility.model)

optional

boolean

required

show/hide email

phoneNumber

boolean

required

show/hide phoneNumber

sites

boolean

optional

show/hide address

birthDate

boolean

optional

show/hide birthDate

stripeConnectOnboard

enum<string>

optional

Allowed values:

completedpendingrequirement-needed

phoneNumber

string | null

optional

string | null

optional

socialLinks

array[object (socialLink.model) {4}] | null

optional

platform

string

required

displayText

string

optional

url

string

required

show

boolean

required

sites

array [object {13}] | null

optional

streetAddress

string

optional

city

string

optional

state

string

optional

country

string

optional

zipCode

string

optional

formattedAddress

string

optional

streetNumber

integer

optional

lat

number

optional

lng

number

optional

isHeadQuarter

boolean

optional

timezone

string

optional

name

string

optional

organizationPageLink

string

optional

status

string

optional

default to live

picture

string | null

optional

cover

string | null

optional

setupProcess

object (setupProcess.model)

optional

step

number

required

section

number

required

review

object (review.model)

optional

totalReviews

integer

required

globalRating

number

required

ratings

array [object {3}]

required

domain

string | null

optional

domain/url o f the organization

settings

object (settings.model)

optional

theme

enum<string>

optional

dark or light

Allowed values:

darklight

language

string

optional

language the user prefers

autoPost

boolean

optional

completion

number

optional

branches

array[object (organizationBranch.model) {2}]

optional

string

optional

organization id

status

enum<string>

optional

status of the branch

Allowed values:

activepending

createdAt

string <date>

optional

date creation

updatedAt

string <date>

optional

date edit

owner

object

optional

owner profile

string

optional

ID of the user

Example:

670775694daebf393b266ea1

username

string

optional

unique username

firstName

string

optional

first name of profile

lastName

string

optional

last name of profile

string <email> | null

optional

Email of the profile

phoneNumber

string | null

optional

Phone number

numberOf

object (profilesNumberOf.model)

optional

followers

array [object {10}] | null

optional

string

required

Example:

6660c7e81f0e3b1cf2c7d687

type

enum<string>

required

Allowed values:

userteacherorganization

story

optional

entityType

enum<string>

optional

Allowed values:

profileorganization

name

string

required

name

picture

string | null

optional

createdAt

string | null

required

date

lastActivity

string | null

optional

mainExperience

string | null

optional

bio

string | null

optional

following

array [object {10}] | null

optional

string

required

Example:

6660c7e81f0e3b1cf2c7d687

type

enum<string>

required

Allowed values:

userteacherorganization

story

optional

entityType

enum<string>

optional

Allowed values:

profileorganization

name

string

required

name

picture

string | null

optional

createdAt

string | null

required

date

lastActivity

string | null

optional

mainExperience

string | null

optional

bio

string | null

optional

members

array[object (organizationMember.rto) {9}] | null

optional

string

optional

Example:

670775694daebf393b266ea1

status

enum<string>

optional

status

Allowed values:

pendingactiveinactive

profile

object (populatedProfile.rto)

optional

ref to profile document

organization

object (organizationProfile.rto)

optional

ref to organization document

role

enum<string>

optional

role of the member

Allowed values:

organization-ownerorganization-adminorganization-member

invited

boolean

optional

to differentiate between existing members and members in invitation list

invitedAt

string <date>

optional

date

secondaryRoles

array[string]

optional

expiresAt

string | null

optional

expiration time of the token for invited members

industry

optional

Any of

industry.rto

null

string

optional

name

string

optional

name of industry

language

string

optional

translate language

entityType

enum<string>

optional

profile or organization

Allowed values:

profileorganization

accountlink

optional

Any of

accountLink.rto

null

ownerId

string

optional

Example:

6664875f427d21851ad83798

onboardUrl

string

optional

expiresAt

number

optional

clientSecret

string | null

optional

🟠403Forbidden