Manage Your Customers' Registration
Get a Link for Your Customer to Complete Their Registration
Once you have created a company and provided the required documents, you can retrieve a link to send to your customer so they can complete their registration and sign their contract.
Use the GET /subscription-link?company=<comp> endpoint to obtain a link that allows your customer to complete their registration:
The link is valid for 31 days.
A new link is generated and sent with each request, while previously generated links remain active. As soon as the user uses one of the links, all other links are automatically deactivated.
NOTE
If you are a non-IOBSP partner, you do not need to provide any documents to access this request.
import requests
url = "https://api-partners.stancer.com/api/partners/subscription-link?company=comp_F5isBBWYDOSnaHhYRc1ZNtF7"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.json())Response:
{
"link": "https://manage.stancer.com/fr/partner-sign-up?key=FFbiofTfKD9eO6tMzSOvMUznlY7Kp2"
}Check a company's progress
Use the GET /registration-progress?company=<comp> endpoint to retrieve a company's progress.
Change a company's status
This endpoint is available in sandbox mode only.
Here is the list of statuses you can use:
| Code | Description |
|---|---|
| notComplete | Registration is not complete; the user has not yet signed the contract. |
| pendingActivation | The user has signed the contract; their application is currently being reviewed by our team. |
| validated | The user's application has been approved; the API keys and payment agreements have not yet been activated. |
| available | The customer's account is active; the API keys and payment contracts are now enabled. |
| pendingDeactivation | The company is pending deactivation, either due to a termination request from the customer or a rejection of the application by our team. |
| deactivate | The company has been deactivated, either due to a termination request from the customer or a rejection of the application by our team. |
Use the PATCH /company-status?company=<comp> endpoint to change a company's status.
Payload JSON
{
"status": "available"
}import requests
url = "https://api-partners.stancer.com/api/partners/company-status?company=comp_F5isBBWYDOSnaHhYRc1ZNtF7"
payload = json.dumps({
"status": "available"
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.json())Response:
{
...
"id": "comp_F5isBBWYDOSnaHhYRc1ZNtF7",
...
"status": "available",
...
}Retrieve company status changes over a specific period
If you want to know whether your client passed our KYC process or was rejected, you can use the endpoint GET /company-status-history?since=<date>&until=<date>&status=<company-status>.
sinceis inclusiveuntilis exclusive
To retrieve the status changes for May 6, you need to set the since date to 2024-05-06 and the until date to 2024-05-07.
This endpoint will return the most recent status update for your companies.
import requests
url = "https://manage.stancer.com/api/partners/company-status-history?since=2024-05-06&until=2024-05-07"
payload = {}
headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.json())Response:
[
{
"date-update": "2024-05-06",
"id": "comp_QGacA9Lc9Ei4RAEgDkhPlCDR",
"status": "pendingActivation"
},
{
"date-update": "2024-05-06",
"id": "comp_F5isBBWYDOSnaHhYRc1ZNtF7",
"status": "available"
},
{
"date-update": "2024-05-06",
"id": "comp_y2LXfWd9rZ7p3QtVyDBbNqp0",
"status": "deactivate",
"terminated-by-stancer": true
}
]You can also pass the status parameter if you want to retrieve only the companies that have been in a specific status during a given period.
You can view the statuses and their descriptions in the Company Status Reference.