POST /partner/activate Request to Activate Partner
activatePartner
If you wish to use Staircase contract to activate a partner, please execute this endpoint.
By executing this API Staircase will be informed that you as our customer want to use requested partner for verification process.
The request body should contain which partner needs to be activated and for which environment. Once the request is received it will take between 1-3 working days to activate a partner. Once the partner is set up the partner will be active and ready to be used. You can check the partner status by calling the Retrieve Partners endpoint. If response for specific partner is "active": true, partner is ready to be used for verification.
List of partners available for activation: Argyle, Atomic, Equifax, Finicity, Meridian, Pinwheel, Truework and Truework-instant.
Request
{
"partner": "partner_name",
"environment": "my-domain.staircaseapi.com"
} Response
Request to Activate API Triggered Successfully
{
"message": "We have started with enabling Partner, Partner will be activated automatically after process is finished within X working days."
} Request data failed validation
{
"message": "{'data': ['Missing data for required field.']}"
} Invalid key for service
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
} Request data failed validation
{
"message": "Invalid request body",
"error": "[object has missing required properties ([\"client_secret\"])]"
} The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
} Parameters
1
| Parameter | Type | Example | Description |
|---|---|---|---|
x-api-key required | string header | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | Staircase Environment API Key |
Request bodyapplication/json
2 fields
application/json| Field | Type | Description |
|---|---|---|
partnerrequired | string | Partner name that needs to be activated |
environmentrequired | string | Environment for which the partner needs to be activated. |
Response 200application/json
1 fields
200application/jsonRequest to Activate API Triggered Successfully
| Field | Type | Description |
|---|---|---|
message | string | Message |
Response 400application/json
1 fields
400application/jsonRequest data failed validation
| Field | Type | Description |
|---|---|---|
message | string | Message |
Response 403application/json
2 fields
403application/jsonInvalid key for service
| Field | Type | Description |
|---|---|---|
message | string | — |
url | string | — |
Response 422application/json
2 fields
422application/jsonRequest data failed validation
| Field | Type | Description |
|---|---|---|
message | string | Message |
error | string | Message |
Response 500application/json
1 fields
500application/jsonThe product has encountered an internal server error
| Field | Type | Description |
|---|---|---|
message | string | Error Message |
Other responses
404