Delete a Business Card
DELETE/api/v8/partner/business-cards/:document_id
Veryfi's Delete a Business Card endpoint allows you to delete a Business Card.
Request
Path Parameters
The unique identifier of the Document.
Responses
- 204
- 400
- 403
- 404
- 429
- 499
- 503
- 504
- default
User error
- application/json
- Schema
- Example (from schema)
Schema
- MALFORMED_PARAMETERS
Default value: fail
Default value: Malformed parameters
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- AUTHENTICATION_CREDENTIALS_WERE_NOT_PROVIDED
Default value: fail
Default value: Authentication credentials were not provided.
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
Gateway timeout. Returned if request takes more than 150 seconds. The request might finish successfully later.
- application/json
- Schema
- Example (from schema)
Schema
- GATEWAY_TIMEOUT
Default value: fail
Default value: Gateway timeout
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [fail, ok]
{
"status": "fail",
"error": "string",
"message": "string",
"details": [
{}
]
}