{
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"phone": "08026662262",
"password": "William01",
"dob": "1990-04-12",
"sex": "male",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria"
}
{
"status": "success",
"message": "organisation member created successfully",
"data": {
"type": "User",
"entity_type": "user",
"kyc": {
"bank": false,
"identityDocument": "Approved",
"selfie": "Approved",
"address": "Approved",
"accredited": "Sophisticated Investor",
"email": true,
"terms": true
},
"activated": true,
"verified": true,
"pin_set": false,
"biometrics_auth": false,
"self_activated": true,
"two_factor_enabled": false,
"flw_baas_reference": "",
"brass_reference": "",
"squad_reference": "",
"manual_reference": "",
"tour": {
"introduction_tour": false,
"wallet_tour": false,
"secondary_tour": false
},
"_id": "67141fc06328250002a4c389",
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"username": null,
"phone": "08026662262",
"dob": "1990-04-12",
"sex": "male",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"createdAt": "2024-10-19T21:08:16.477Z",
"updatedAt": "2024-10-19T21:08:16.551Z",
"dealroom_member": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndpbGxtZW1iZXJAeW9wbWFpbC5jb20iLCJ0eXBlIjoiVXNlciIsImlhdCI6MTcyOTM3MjA5NiwiZXhwIjoxNzI5NDU4NDk2fQ.Vczi6BN4uEDV4tU_ELuPCsDq4NrabJPocZFFKmUTrC4"
}
}
Members
Create Member
Provision a member of your organisation’s syndicate
POST
api
/
member
{
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"phone": "08026662262",
"password": "William01",
"dob": "1990-04-12",
"sex": "male",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria"
}
{
"status": "success",
"message": "organisation member created successfully",
"data": {
"type": "User",
"entity_type": "user",
"kyc": {
"bank": false,
"identityDocument": "Approved",
"selfie": "Approved",
"address": "Approved",
"accredited": "Sophisticated Investor",
"email": true,
"terms": true
},
"activated": true,
"verified": true,
"pin_set": false,
"biometrics_auth": false,
"self_activated": true,
"two_factor_enabled": false,
"flw_baas_reference": "",
"brass_reference": "",
"squad_reference": "",
"manual_reference": "",
"tour": {
"introduction_tour": false,
"wallet_tour": false,
"secondary_tour": false
},
"_id": "67141fc06328250002a4c389",
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"username": null,
"phone": "08026662262",
"dob": "1990-04-12",
"sex": "male",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"createdAt": "2024-10-19T21:08:16.477Z",
"updatedAt": "2024-10-19T21:08:16.551Z",
"dealroom_member": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndpbGxtZW1iZXJAeW9wbWFpbC5jb20iLCJ0eXBlIjoiVXNlciIsImlhdCI6MTcyOTM3MjA5NiwiZXhwIjoxNzI5NDU4NDk2fQ.Vczi6BN4uEDV4tU_ELuPCsDq4NrabJPocZFFKmUTrC4"
}
}
Creates a GetEquity account and enrols it as a member of your organisation’s syndicate. The returned
_id is the member id every other member-scoped endpoint takes in its path — funding, investing, orders, balances and withdrawals.
Because the member is provisioned by you, the account is created already verified and KYC-approved (Sophisticated Investor), so it can transact immediately. This is the entry point of the Managed integration; the Direct model uses Customers instead.
If an account already exists with the given email, that account is reused and linked to your organisation rather than a duplicate being created. A phone that is already registered to a different account is rejected.
A member.created webhook is dispatched once the member is provisioned.
All eleven body fields are required. The request is rejected with
400 if any is missing, and also if any field not listed below is sent — unknown keys are not ignored. username in particular is not accepted on this endpoint.{
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"phone": "08026662262",
"password": "William01",
"dob": "1990-04-12",
"sex": "male",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria"
}
string
required
Member’s first name.
string
required
Member’s last name.
string
required
Member’s email address. Stored lowercased, and unique across GetEquity — an existing account with this email is linked to your syndicate instead of a new one being created.
string
required
Member’s phone number. Spaces,
+, - and parentheses are stripped before storage, so +234 802 666 2262 and 08026662262 are both accepted. Must not already belong to another GetEquity account.string
required
Member’s password. Maximum 30 characters.
string
required
Member’s date of birth. Use
YYYY-MM-DD.string
required
Member’s gender.
string
required
Member’s residential address.
string
required
Member’s city.
string
required
Member’s state or province.
string
required
Member’s country.
This endpoint is rate limited to 100 requests per minute per API key.
{
"status": "success",
"message": "organisation member created successfully",
"data": {
"type": "User",
"entity_type": "user",
"kyc": {
"bank": false,
"identityDocument": "Approved",
"selfie": "Approved",
"address": "Approved",
"accredited": "Sophisticated Investor",
"email": true,
"terms": true
},
"activated": true,
"verified": true,
"pin_set": false,
"biometrics_auth": false,
"self_activated": true,
"two_factor_enabled": false,
"flw_baas_reference": "",
"brass_reference": "",
"squad_reference": "",
"manual_reference": "",
"tour": {
"introduction_tour": false,
"wallet_tour": false,
"secondary_tour": false
},
"_id": "67141fc06328250002a4c389",
"fname": "William",
"lname": "Ajasco",
"email": "willmember@yopmail.com",
"username": null,
"phone": "08026662262",
"dob": "1990-04-12",
"sex": "male",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria",
"homeAddress": "4 Omoba Murphy Ayetoro Street",
"createdAt": "2024-10-19T21:08:16.477Z",
"updatedAt": "2024-10-19T21:08:16.551Z",
"dealroom_member": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IndpbGxtZW1iZXJAeW9wbWFpbC5jb20iLCJ0eXBlIjoiVXNlciIsImlhdCI6MTcyOTM3MjA5NiwiZXhwIjoxNzI5NDU4NDk2fQ.Vczi6BN4uEDV4tU_ELuPCsDq4NrabJPocZFFKmUTrC4"
}
}
data._id is the member id to pass to the member-scoped endpoints. data.token is a member session JWT valid for 24 hours — you do not need it to act on the member’s behalf, since those calls authenticate with your organisation’s secret key.Was this page helpful?
