On this page:
For an Individual seller to use Primefy as a partner for payment processing and more, some information is required, as follows:
<aside> 💡 If you want to register a Legal Entity establishment, follow this documentation.
</aside>
<aside> 💡 The Plans are associated with commercial rates and must be applied during the establishment registration. The Plan's name will be provided by the Primefy sales team.
</aside>
<aside> 💡 The fields that expect Base64 values must be correctly converted and have a valid Base64 value. You can use online converters for this purpose.
</aside>
<aside> ℹ️ "Learn more about baseUrl and other important information here.
</aside>
{{**baseUrl**}}/signup/
<aside> 💡 To register an establishment within the same business, the 'businessId' property, containing the Business number, must be provided in the following body:
</aside>
{
"businessId": 1010, // use this only to register the new establishment within an existing business
"plan": "standard",
"identificationNumber": "74559147922",
"name": "Sueli Esther Moura",
"email": "[email protected]",
"password": "y7Kwm6TqhZ"
}
{
"id": 705,
"name": "Sueli Esther Moura",
"identificationNumber": "74559147922",
"email": "[email protected]",
"status": "onboarding"
}
<aside> 💡 From this point on, all endpoints are protected and require the POST to be authenticated. Check here how to generate the token for the user.
</aside>
{{**baseUrl**}}/signup/stores/:store-id/owner-details/
{
"fullName": "Sueli Esther Moura",
"identificationNumber": "74559147922",
"birthdate": "2010-12-13",
"phone": "(11) 3531-1472"
}
{
"id": 177,
"storeId": 705,
"fullName": "Sueli Esther Moura",
"identificationNumber": "74559147922",
"birthDate": "2010-12-13",
"phone": "(11) 3531-1472"
}
{{**baseUrl**}}/signup/stores/:store-id/business-details
<aside> 💡 The MCC can be obtained from the Primefy sales team.
</aside>
{
"mcc": "107",
"companyName": "Sueli Esther Moura 74559147922",
"socialName": "Quick Wash Lava-Rapido",
"encodedLogoImage": "base64EncondedFile"
}
{
"id": 704,
"companyName": "Sueli Esther Moura 74559147922",
"socialName": "Quick Wash Lava-Rapido",
"mcc": 107,
"logoPath": "<https://preme.s3.us-east-2.amazonaws.com/logotipos/01a7afa6-a19e-4cb4-a870-0a94745fc514.png>"
}
{{**baseUrl**}}/signup/stores/:store-id/address
{
"street": "Alberto Santos Dummond",
"number": 124,
"reference": null,
"district": "São José",
"zipCode": "14800000",
"state": "SP",
"city": "São Paulo",
"country": "BR"
}
{
"id": 705,
"businessId": 453,
"identificationNumber": "74559147922",
"companyName": "Sueli Esther Moura 74559147922",
"socialName": "Quick Wash Lava-Rapido",
"name": "Quick Wash Lava-Rapido",
"logoPath": "<https://preme.s3.us-east-2.amazonaws.com/logotipos/a8675258-395d-4e3d-9f52-46f21c0d64b3.png>",
"email": "[email protected]",
"phone": "(11) 3531-1472",
"address": {
"street": "Alberto Santos Dummond",
"number": "124",
"reference": null,
"district": "São José",
"city": "São Paulo",
"zipCode": "14800000",
"state": "SP",
"country": "BR"
},
"owner": {
"id": 177,
"storeId": 705,
"fullName": "Sueli Esther Moura",
"identificationNumber": "74559147922",
"birthDate": "12/13/2010 00:00:00",
"phone": "(11) 3531-1472",
"address": {
"street": "Alberto Santos Dummond",
"number": "124",
"reference": null,
"district": "São José",
"city": "São Paulo",
"zipCode": "14800000",
"state": "SP",
"country": "BR"
}
},
"status": "pending",
"createdOn": "2022-09-26T15:37:44",
"updatedOn": "2022-09-26T15:55:26.5924684Z"
}
The bank account is required for the establishment to be approved to start its sales. Check this link on how to create the bank account
{{**baseUrl**}}/signup/stores/:store-id/documents
[
{
"type": "atividade",
"encodedFile": "base64EncondedFile"
},
{
"type": "residencia",
"encodedFile": "base64EncondedFile"
},
{
"type": "identificacao",
"encodedFile": "base64EncondedFile"
},
{
"type": "identificacao",
"encodedFile": "base64EncondedFile"
}
]
[
{
"storeId": 705,
"documents": [
{
"type": "Atividade",
"filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/atividade/f4e83200-5dc6-48d8-b398-8d7e126cfbc5.png>"
},
{
"type": "Residencia",
"filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/residencia/bf2d523d-6bdf-484c-b00a-66894033384e.png>"
},
{
"type": "Identificacao",
"filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/identificacao/006d5cfe-6fcb-4037-8f74-7d203cdb5392.png>"
},
{
"type": "Identificacao",
"filePath": "<https://preme.s3.us-east-2.amazonaws.com/documentos/identificacao/127d5cfe-6fxb-9950-8f74-7d203rdo5392.png>"
}
]
}
]
Related Content
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/3b9499ff-5ea9-4c31-bf0c-b17879f3fe95/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/3b9499ff-5ea9-4c31-bf0c-b17879f3fe95/PUT.png" width="40px" /> PUT - Edit establishment
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/fcb3143f-7ee7-49a3-89c4-8fdec896bbf6/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/fcb3143f-7ee7-49a3-89c4-8fdec896bbf6/POST.png" width="40px" /> POST - Add a new establishment - Commercial (Legal Entity)
</aside>
