Skip to navigation

Screen a wallet and retain a transaction reference (compatibility)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Myaza-VersionstringOptional
X-Request-IdstringOptional<=128 characters
Idempotency-KeystringRequiredformat: "^[A-Za-z0-9._:~-]+$"8-200 characters

Request

This endpoint expects an object.
networkstringRequired1-40 characters

Network identifier, such as ethereum or TRX. Known aliases are normalised; other well-formed identifiers are accepted without a static allowlist. Screening availability is determined when the request runs. An asset such as USDT is separate.

transactionHashstringRequired<=128 characters

Reference retained by Myaza; excluded from the screening request.

directionenumRequired
Allowed values:
counterpartyAddressstringRequired<=256 characters
assetstringOptional<=20 characters
sandboxScenariostringOptional<=100 characters
Myaza Trust test environment only.
subjectobjectOptional
depositAddressstringOptional<=256 characters
Optional receiving wallet reference for inbound transactions.

Response

Success
screeningobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error