Profiles are the basis under which any investor, manager, or founder/operator can take action on the Syndicately platform. Each user in your stack will need to be assigned a user_id in our system, that user_idwill be used to create any profiles that are associated with that user. A user can have unlimited profiles but each profile must be created and approved independently of one another.

The first time a new user creates a profile using the POST endpoint, you will submit the POST request with the user_id as null and that will let the system know that is is also a new user and assign them an ID which will be in the response. For future POST, GET or PATCH calls to the profiles endpoint you will need to include the user_id of the appropriate user to get a correctly validated response.

Profile Endpoints #

• GET – /api/profiles/{id}/document-share-link (Get W-9 document uuid and embed link for signing)

• GET – /api/profiles (fetch list of profiles)

• POST – /api/profiles (create user profile)

• PUT – /api/profiles/{id} (update user profile)

• GET – /api/profile/{id} (fetch a specific profile)

• POST – /api/profiles/{id}/bank-account (link external bank account to profile for ACH transfers) (U.S. profiles only, international investors must use Wire)

To create a new profile for a new or existing user you need to submit a POST request to the following endpoint:

https://client.syndicately.com/api/v1/api/profiles

To create a new profile you need to use a POST call to the /api/profiles endpoint.

When creating an account, you will need to specify the /accounts.write scope. Below is the request body schema

• type (array, string) *required

  • This is the type of profile based on the tax identification that a user wants to use to take action on the Syndicately platform.

  • values: individual, entity, trust, or joint

  • note: type trustcan only be used with the investor role currently

• role (array, string) *required

  • The role of a profile defines what role in the deal process this profile can be used for, if a user wants to use the same tax ID to invest in and manage deals they will need to create two profiles for each role

  • values: investor, manager, founder

  • Note: role founder can be used to identify the part that is to be the recipient of ht e investment capital raised.

• first_name (string) *required

  • the first name for an individual profile type or the first name of the primary representative for a entity or trust profile types

• last_name (string) *required

  • the last name for an individual profile type or the first name of the primary representative for a entity or trust profile type

• phone (integer) *required

  • the contact phone number for an individual profile or the primary representative for a entity or trustprofile type

• date_of_birth (string) *required

  • the date of birth for an individual profile or the primary representative for a entity or trust profile type

• tax_id (string) *required

  • the social security number for an individual profile or the primary representative for a entity or trustprofile type

• address1 (string) *required

  • address line 1 for an individual profile or the primary representative for a entity or trust profile type

  • note: this field must match the primary address for the individual or representative that is on file with the IRS

• address2 (string)

  • address line 2 for an individual profile or the primary representative for a entity or trust profile type

  • note: this field must match the primary address for the individual or representative that is on file with the IRS

• city (string) *required

  • name of the city/town for an individual profile or the primary representative for a entity or trust profile type

  • note: this field must match the primary address for the individual or representative that is on file with the IRS

• country_id (integer, list) *required

  • the country of residence for an individual profile or the primary representative for a entity or trust profile type

  • note: the IDs for countries can be found using the GET /api/countries endpoint

• state_id (integer, list) *required

  • the state of residence for an individual profile or the primary representative for a entity or trust profile type

  • note: the IDs for countries can be found using the GET /api/states endpoint

• zip(integer) *required

  • the zip code for an individual profile or the primary representative for a entity or trust profile type

  • note: this field must match the primary address for the individual or representative that is on file with the IRS

• accredited_investor_document (string, list)

  • the accredited investor attestation for an individual, entity, or trust profile type

  • note: the IDs for accredited investor qualifications can be found using the GET /api/investor-qualifications endpoint, this is required if the profile role is investor

The following request body schema are used if the profile type is entity or trust. #

• entity_type_id (string)

  • if profile type is entity then required

  • values: llc, partnership, c corp, s corp

• type (string)

  • if profile type is trust then required

  • values: revokable, irrevokable

• passthrough (string)

  • value: yes or no

  • note: this is user driven and notes if the entity or trust profile type has passthrough taxation treatment. this impacts the proper generation of any tax forms for the user

• entity_name (string)

  • if profile type is entity or trust then required

  • note: legal name of the company or trust on record with the IRS and the legal name used to apply for an EIN number

• tax_id (string)

  • if profile type is entity or trust then required

  • note: EIN number of the company or trust issued by the IRS

• state_of_formation (integer)

  • the id for the state that the company of trust was formed in

  • note: the IDs for states can be found using the GET /api/states endpoint

• beneficialOwnerID (string)

  • the ID of any additional beneficial owners if any other than the primary representative

• signatoryID (string)

  • the ID of any approved signatories authorized to act on behalf of the entity or trust if any other than the primary representative

• address1 (string)

  • required if entity or trust profile types

  • business address line 1 for the company or trust

• address2 (string)

  • business address line 2 for the company or trust

• city (string)

  • required if entity or trust profile types

  • city/town for the company or trust

• country_id (integer, list)

  • the country that the entity or trust is located

  • note: the IDs for countries can be found using the GET /api/countries endpoint

• state_id (integer, list)

  • the state that the entity or trust is located

  • note: the IDs for countries can be found using the GET /api/states endpoint

Responses #

• 200 – Profile created successfully

  Response body schema

  • tax_status_documentation

    • the W-9 for an individual, entity, or trust profile type. Depending on how a entity or trust is treated for tax purposes the W-9 will auto-populate based on the state of the passthrough or typefields.

    • note: given a delay in the document generation system this field will be missing a share_uuid in the response and you will need to load the document iframe by making a separate call to GET GET /api/{id}/documen-share-link endpoint with the profile id after the initial response. This will return the share_uuidand the embed_linkyou can use to load the document for signing by the user.

  • is_active

    • this field denotes weather or not the profile is active/inactive and is a status field only within the Syndicately ecosystem and does not affect any other integrations. For a profile to be active it must have all required fields completed, once all required fields are completed the profile is set to active by default.

• 422 – Request body could not be processed

• 429 – Request failed due to rate limiting

• Default – Empty Response For Unauthorized or Any Other Status Code