HomeGuidesAPI Reference
API Reference

API Error Codes Reference

This document lists all defined API error codes.

GeneralClientErr

  • Code: 1000
  • HTTP Status: 400
  • Description: general client error
  • Message Template: General error has occurred, For more information, please contact Support Team.

MissingPathParamErr

  • Code: 1001
  • HTTP Status: 400
  • Description: missing required path parameter
  • Message Template: Missing required path parameter: "{{ParameterName}}"

InvalidRequestFormatErr

  • Code: 1002
  • HTTP Status: 400
  • Description: invalid request format
  • Message Template: Invalid request format

InvalidPathParamErr

  • Code: 1003
  • HTTP Status: 400
  • Description: invalid path parameter
  • Message Template: Invalid path parameter: "{{ParameterName}}"

UnsupportedPathParamErr

  • Code: 1004
  • HTTP Status: 400
  • Description: unsupported path parameter
  • Message Template: Unsupported path parameter: "{{ParameterName}}"

GeneralResourceNotFoundErr

  • Code: 1100
  • HTTP Status: 404
  • Description: general resource not found
  • Message Template: General resource not found

ResourceNotFoundErr

  • Code: 1101
  • HTTP Status: 404
  • Description: resource not found
  • Message Template: Resource not found: "{{ResourceName}}"

PathParamRecordNotFoundErr

  • Code: 1102
  • HTTP Status: 404
  • Description: path parameter record not found
  • Message Template: Path parameter record not found: "{{ParameterName}}"

GeneralIdempotencyErr

  • Code: 1200
  • HTTP Status: 409
  • Description: general idempotency error
  • Message Template: General idempotency error

MissingIdempotencyKeyErr

  • Code: 1201
  • HTTP Status: 409
  • Description: missing idempotency key
  • Message Template: Missing idempotency key

InvalidIdempotencyKeyFormatErr

  • Code: 1202
  • HTTP Status: 409
  • Description: invalid idempotency key format
  • Message Template: Invalid idempotency key format

DuplicateIdempotencyKeyErr

  • Code: 1203
  • HTTP Status: 409
  • Description: duplicate idempotency key
  • Message Template: Duplicate idempotency key

IdempotencyKeyConflictErr

  • Code: 1204
  • HTTP Status: 409
  • Description: idempotency key conflict
  • Message Template: Idempotency key conflict

IdempotencyKeyExpiredErr

  • Code: 1205
  • HTTP Status: 409
  • Description: idempotency key expired
  • Message Template: Idempotency key expired

GeneralNonceErr

  • Code: 1210
  • HTTP Status: 409
  • Description: general nonce error
  • Message Template: General nonce error

MissingNonceErr

  • Code: 1211
  • HTTP Status: 409
  • Description: missing nonce
  • Message Template: Missing nonce

InvalidNonceFormatErr

  • Code: 1212
  • HTTP Status: 409
  • Description: invalid nonce format
  • Message Template: Invalid nonce format

NonceAlreadyUsedErr

  • Code: 1213
  • HTTP Status: 409
  • Description: nonce already used
  • Message Template: Nonce already used

NonceExpiredErr

  • Code: 1214
  • HTTP Status: 409
  • Description: nonce expired
  • Message Template: Nonce expired

NonceNotAcceptedErr

  • Code: 1215
  • HTTP Status: 409
  • Description: nonce not accepted
  • Message Template: Nonce not accepted

BadRequestErr

  • Code: 1300
  • HTTP Status: 400
  • Description: bad request
  • Message Template: Bad request

MissingQueryParamErr

  • Code: 1301
  • HTTP Status: 400
  • Description: missing required query parameter
  • Message Template: Missing required query parameter: "{{ParameterName}}"

InvalidQueryParamErr

  • Code: 1302
  • HTTP Status: 400
  • Description: invalid query parameter
  • Message Template: Invalid query parameter: "{{ParameterName}}"

UnsupportedQueryParamErr

  • Code: 1303
  • HTTP Status: 400
  • Description: unsupported query parameter
  • Message Template: Unsupported query parameter "{{ParameterName}}"

ConflictingQueryParamsErr

  • Code: 1304
  • HTTP Status: 400
  • Description: conflicting query parameters
  • Message Template: Conflicting query parameters

GeneralServerErr

  • Code: 2000
  • HTTP Status: 500
  • Description: general server error
  • Message Template: General server error

InternalErrorCodeErr

  • Code: 2001
  • HTTP Status: 500
  • Description: internal error code
  • Message Template: Internal error code

ServiceUnavailableErr

  • Code: 2002
  • HTTP Status: 503
  • Description: service unavailable
  • Message Template: Service unavailable

GatewayTimeoutErr

  • Code: 2003
  • HTTP Status: 504
  • Description: gateway timeout
  • Message Template: Gateway timeout

DataProcessingErr

  • Code: 2004
  • HTTP Status: 500
  • Description: data processing error
  • Message Template: Data processing error: "{{ErrorMessage}}"

DatabaseErr

  • Code: 2100
  • HTTP Status: 500
  • Description: database error
  • Message Template: Database error

DatabaseConnectionFailedErr

  • Code: 2101
  • HTTP Status: 500
  • Description: database connection failed
  • Message Template: Database connection failed

QueryExecutionFailedErr

  • Code: 2102
  • HTTP Status: 500
  • Description: query execution failed
  • Message Template: Query execution failed

ServiceErr

  • Code: 2200
  • HTTP Status: 500
  • Description: service error
  • Message Template: Service error

ExternalServiceFailureErr

  • Code: 2201
  • HTTP Status: 502
  • Description: external service failure
  • Message Template: External service failure

InternalServiceFailureErr

  • Code: 2202
  • HTTP Status: 500
  • Description: internal service failure
  • Message Template: Internal service failure

GeneralAuthErr

  • Code: 3000
  • HTTP Status: 401
  • Description: general authentication error
  • Message Template: General authentication error

InvalidCredentialsErr

  • Code: 3001
  • HTTP Status: 401
  • Description: invalid credentials
  • Message Template: Invalid credentials

MissingTokenErr

  • Code: 3100
  • HTTP Status: 401
  • Description: missing token
  • Message Template: Missing token

InvalidTokenFormatErr

  • Code: 3101
  • HTTP Status: 401
  • Description: invalid token format
  • Message Template: Invalid token format

ExpiredTokenErr

  • Code: 3102
  • HTTP Status: 401
  • Description: expired token
  • Message Template: Expired token

TokenVerificationFailedErr

  • Code: 3103
  • HTTP Status: 401
  • Description: token verification failed
  • Message Template: Token verification failed

TokenRevokedErr

  • Code: 3104
  • HTTP Status: 401
  • Description: token revoked
  • Message Template: Token revoked

MissingSignatureErr

  • Code: 3200
  • HTTP Status: 401
  • Description: missing signature
  • Message Template: Missing signature

InvalidSignatureFormatErr

  • Code: 3201
  • HTTP Status: 401
  • Description: invalid signature format
  • Message Template: Invalid signature format

ExpiredSignatureErr

  • Code: 3202
  • HTTP Status: 401
  • Description: expired signature
  • Message Template: Expired signature

SignatureMismatchErr

  • Code: 3203
  • HTTP Status: 401
  • Description: signature mismatch
  • Message Template: Signature mismatch

SignatureVerificationFailedErr

  • Code: 3204
  • HTTP Status: 401
  • Description: signature verification failed
  • Message Template: Signature verification failed

MissingPublicKeyErr

  • Code: 3300
  • HTTP Status: 401
  • Description: missing public key
  • Message Template: Missing public key

InvalidPublicKeyErr

  • Code: 3301
  • HTTP Status: 401
  • Description: invalid public key
  • Message Template: Invalid public key

ExpiredPublicKeyErr

  • Code: 3302
  • HTTP Status: 401
  • Description: expired public key
  • Message Template: Expired public key

PublicKeyNotFoundErr

  • Code: 3303
  • HTTP Status: 401
  • Description: public key not found
  • Message Template: Public key not found

PublicKeyRevokedErr

  • Code: 3304
  • HTTP Status: 401
  • Description: public key revoked
  • Message Template: Public key revoked

AccessDeniedErr

  • Code: 3400
  • HTTP Status: 403
  • Description: access denied
  • Message Template: Access denied

InsufficientPermissionsErr

  • Code: 3401
  • HTTP Status: 403
  • Description: insufficient permissions
  • Message Template: Insufficient permissions

AccountLockedErr

  • Code: 3402
  • HTTP Status: 403
  • Description: account locked
  • Message Template: Account locked

NotAuthorizedRoleErr

  • Code: 3403
  • HTTP Status: 403
  • Description: not authorized role
  • Message Template: Organization is not authorized as "{{RoleName}}" to perform this action

GeneralValidationErr

  • Code: 4000
  • HTTP Status: 400
  • Description: general validation error
  • Message Template: General validation error

MissingRequiredFieldErr

  • Code: 4001
  • HTTP Status: 400
  • Description: missing required field
  • Message Template: Missing required field: "{{FieldName}}"

InvalidFieldFormatErr

  • Code: 4002
  • HTTP Status: 400
  • Description: invalid field format
  • Message Template: Invalid format for field: "{{FieldName}}"

InvalidFieldValueErr

  • Code: 4003
  • HTTP Status: 400
  • Description: invalid field value
  • Message Template: Invalid field value for field: "{{FieldName}}"

DataConstraintViolationErr

  • Code: 4100
  • HTTP Status: 400
  • Description: data constraint violation
  • Message Template: Data constraint violation: "{{ConstraintName}}"

DuplicateEntryErr

  • Code: 4101
  • HTTP Status: 400
  • Description: duplicate entry
  • Message Template: Duplicate entry

MinLengthViolationErr

  • Code: 4102
  • HTTP Status: 400
  • Description: minimum length violation
  • Message Template: Minimum length violation: "{{FieldName}}"

MaxLengthViolationErr

  • Code: 4103
  • HTTP Status: 400
  • Description: maximum length violation
  • Message Template: Maximum length violation: "{{FieldName}}"

MinAmountNotMetErr

  • Code: 4104
  • HTTP Status: 400
  • Description: minimum amount not met
  • Message Template: Minimum amount not met

MaxAmountExceededErr

  • Code: 4105
  • HTTP Status: 400
  • Description: maximum amount exceeded
  • Message Template: Maximum amount exceeded

InvalidAmountErr

  • Code: 4106
  • HTTP Status: 400
  • Description: invalid amount
  • Message Template: Amount is not valid

InvalidEnumValueErr

  • Code: 4107
  • HTTP Status: 400
  • Description: invalid enum value
  • Message Template: Invalid enum value: "{{EnumValue}}"

AssetMetadataConflictErr

  • Code: 4108
  • HTTP Status: 400
  • Description: asset metadata conflict
  • Message Template: Asset metadata and config cannot be provided at the same time

OpenTimePastErr

  • Code: 4109
  • HTTP Status: 400
  • Description: openTime in the past
  • Message Template: openTime should not be in the past

CloseTimePastErr

  • Code: 4110
  • HTTP Status: 400
  • Description: closeTime in the past
  • Message Template: closeTime should not be in the past

CloseTimeIntervalErr

  • Code: 4111
  • HTTP Status: 400
  • Description: closeTime interval violation
  • Message Template: closeTime and openTime must have a minimum interval of {{MinInterval:duration}}

CloseTimeBeforeOpenErr

  • Code: 4112
  • HTTP Status: 400
  • Description: closeTime before openTime
  • Message Template: closeTime should be after the openTime

GeneralDatabaseErr

  • Code: 5000
  • HTTP Status: 500
  • Description: general database error
  • Message Template: General database error

RecordNotFoundErr

  • Code: 5001
  • HTTP Status: 404
  • Description: record not found
  • Message Template: Record not found

DuplicateRecordErr

  • Code: 5002
  • HTTP Status: 409
  • Description: duplicate record
  • Message Template: Duplicate record

QueryErr

  • Code: 5100
  • HTTP Status: 500
  • Description: query error
  • Message Template: Query error

QuerySyntaxErr

  • Code: 5101
  • HTTP Status: 500
  • Description: query syntax error
  • Message Template: Syntax error

QueryTimeoutErr

  • Code: 5102
  • HTTP Status: 500
  • Description: query timeout
  • Message Template: Timeout

GeneralExternalServiceErr

  • Code: 6000
  • HTTP Status: 502
  • Description: general external service error
  • Message Template: General external service error

ExternalApiTimeoutErr

  • Code: 6001
  • HTTP Status: 504
  • Description: external API timeout
  • Message Template: External API timeout

ExternalApiInvalidResponseErr

  • Code: 6002
  • HTTP Status: 502
  • Description: external API invalid response
  • Message Template: External API invalid response

IntegrationErr

  • Code: 6100
  • HTTP Status: 502
  • Description: integration error
  • Message Template: Integration error

FailedExternalServiceConnectionErr

  • Code: 6101
  • HTTP Status: 502
  • Description: failed external service connection
  • Message Template: Failed to connect to external service

DataMappingErr

  • Code: 6102
  • HTTP Status: 502
  • Description: data mapping error
  • Message Template: Data mapping error

GeneralProcessingErr

  • Code: 7000
  • HTTP Status: 500
  • Description: general processing error
  • Message Template: General processing error

DuplicateOperationErr

  • Code: 7001
  • HTTP Status: 409
  • Description: duplicate operation
  • Message Template: Duplicate operation

InvalidOperationErr

  • Code: 7100
  • HTTP Status: 400
  • Description: invalid operation
  • Message Template: Invalid operation

InvalidOperationOnDisabledObjectErr

  • Code: 7101
  • HTTP Status: 400
  • Description: invalid operation on disabled object
  • Message Template: Invalid operation on a disabled {{ObjectType}}

InvalidOperationOnEnabledObjectErr

  • Code: 7102
  • HTTP Status: 400
  • Description: invalid operation on enabled object
  • Message Template: Invalid operation on an enabled {{ObjectType}}

DuplicateSharingOperationErr

  • Code: 7103
  • HTTP Status: 409
  • Description: duplicate sharing operation
  • Message Template: Duplicate sharing operation

ItemNotSharedErr

  • Code: 7104
  • HTTP Status: 403
  • Description: item not shared with organization
  • Message Template: This item has not been shared with your organization

CounterpartyNotEligibleErr

  • Code: 7105
  • HTTP Status: 403
  • Description: counterparty not eligible
  • Message Template: Counterparty is not eligible

InvalidOperationOnExpiredObjectErr

  • Code: 7200
  • HTTP Status: 400
  • Description: invalid operation on expired object
  • Message Template: Invalid operation on an expired object

InvalidOperationOnCompletedObjectErr

  • Code: 7201
  • HTTP Status: 400
  • Description: invalid operation on completed object
  • Message Template: Invalid operation on a completed object

InvalidOperationOnCancelledObjectErr

  • Code: 7202
  • HTTP Status: 400
  • Description: invalid operation on cancelled object
  • Message Template: Invalid operation on a cancelled object

InvalidOperationOnRejectedObjectErr

  • Code: 7203
  • HTTP Status: 400
  • Description: invalid operation on rejected object
  • Message Template: Invalid operation on a rejected object

InvalidOperationOnNotActiveObjectErr

  • Code: 7204
  • HTTP Status: 400
  • Description: invalid operation on not active object
  • Message Template: Invalid operation on a not active object

InvalidOperationOnActiveObjectErr

  • Code: 7205
  • HTTP Status: 400
  • Description: invalid operation on active object
  • Message Template: Invalid operation on an active object

InvalidOperationOnNoneActiveObjectErr

  • Code: 7206
  • HTTP Status: 400
  • Description: invalid operation on nonactive object
  • Message Template: Invalid operation on a nonactive object

InsufficientFundsErr

  • Code: 7210
  • HTTP Status: 400
  • Description: insufficient funds
  • Message Template: Insufficient funds

OrganizationIdDoesNotExistErr

  • Code: 7300
  • HTTP Status: 404
  • Description: organization id does not exist
  • Message Template: Organizations ids do not exist (ids: {{orgIds:[]string}})

InconsistentFieldValuesErr

  • Code: 7301
  • HTTP Status: 400
  • Description: inconsistent values found for a given field
  • Message Template: Inconsistent values detected for '{{fieldName}}'- all instances must match

NotEnoughAmountErr

  • Code: 7302
  • HTTP Status: 409
  • Description: not enough amount
  • Message Template: The requested amount exceeds the available units amount

TBDError4XX

  • Code: 9997
  • HTTP Status: 400
  • Description: Error code to be when code and message not decided yet, with 4xx http status
  • Message Template: TDB error, wrapped error "{{WrappedError}}"

TBDError5XX

  • Code: 9998
  • HTTP Status: 500
  • Description: Error code to be when code and message not decided yet, with 5xx http status
  • Message Template: TDB error, wrapped error "{{WrappedError}}"

UnknownError

  • Code: 9999
  • HTTP Status: 500
  • Description: unknown error
  • Message Template: The operation could not be completed successfully. Please contact Support team