Search Signers
GET/v3/applications/:appId/envs/:appEnv/signers-search
This endpoint searches for signers within an application based on a filter.
Request
Path Parameters
The application identifier which is used to identify the application used.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
Query Parameters
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The search results for signers.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
signers
object[]
required
The unique identifier of the signer.
The external identifier of the signer - A reference that you can set to match with your internal systems.
The first name of the signer.
The last name of the signer.
The email of the signer.
Possible values: [CREATED
, PENDING
, BLOCKED
, ACTIVE
]
The status of the signer.
Possible values: [firstName
, lastName
, email
, phoneNumber
, nationality
, birthDate
, birthPlace
, birthCountry
]
Indicates whether the signer is recurrent or not (one-off).
{
"signers": [
{
"signerId": "string",
"externalId": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"status": "CREATED",
"alreadyProvidedInputs": [
"firstName"
],
"isRecurrent": true
}
],
"total": 0
}
Bad request error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Unauthorized error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Timeout
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"status": 0,
"code": "string",
"context": {}
}