DN Assist API

Diebold Nixdorf API for SelfService Assistance — remote assistance, session and device interaction operations against self-service terminals. 23 paths with basic, bearer and JWE-bearer authentication; OpenAPI 3.0.1, version 1.0.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 23 operations across 23 paths, and defines 168 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://localhost:8080/tm-assist-api/v1.

23 operations 23 paths 168 schemas 12 GET5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

1.0

Base URL

https://{customer-host}:8080/tm-assist-api/v1

Authentication

HTTP Basic, HTTP Bearer, HTTP Bearer

Resource Areas

Authentication & Security 3

DN Assist API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic). It accepts HTTP bearer tokens (Any string) (bearer). It accepts HTTP bearer tokens (Any string) (jweBearer). By default, every request must be authenticated.

basic — Authorization will contain base 64 encoded userName:password string
bearer — Authorization will contain token received using getToken request as Bearer Token
jweBearer — Authorization will contain Bearer encryptedJWT. JWT will be encrypted with backend endpoint public key

Paths & Operations 23

Across 23 paths, the API surfaces 23 operations — 12 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

DN Assist API 23

PUT

/tellerReadiness

Sets teller readiness status in TM for the corresponding teller id

3 params body → 200400500401403

GET

/loadConfig/{tenantName}

Retrieve configuration associated with tenantName

4 params → 200400500401403

GET

/twilioTaskRouter/{tenantName}/{tellerName}

Retrieve twillio task router token

5 params → 200400500401403

GET

/terminalStatus/{tenantName}

Retrieve terminal status details

4 params → 200400500401403

GET

/terminalData/{tenantName}/{workstationId}

Retrieve terminal and associated cassette counter details

5 params → 200400500401403

GET

/sessionData/{tenantName}/{workstationId}

Retrieve session data of current transaction

5 params → 200400500401403

GET

/customerData/{tenantName}/{externalCustomerId}

Retrieve customer account details

5 params → 200400500401403

GET

/checkDetails/{tenantName}/{workstationId}/{transactionId}

Retrieve checks details

6 params → 200400500401403

PUT

/updateCheckDetails/{tenantName}

Update check details

4 params body → 200400500401403

GET

/imagesFromTransaction/{tenantName}/{workstationId}/{transactionId}

Retrieve list of images details

getImagesByWorkstationIdAndTransactionId 6 params → 200400500401403

GET

/tokenZoomTeller/{tenantName}

Gets zoom JWT for connecting to video meeting room

7 params → 200400500401403

PUT

/updateImage/{tenantName}

Update image details

4 params body → 200400500401403

POST

/saveImageFromTeller/{tenantName}

Save image details

4 params body → 200400500401403

PUT

/deleteImage/{tenantName}

Delete image details

4 params body → 200400500401403

POST

/limit/{tenantName}

Save limit for a given business case

4 params body → 200400500401403

GET

/limit/categories/{tenantName}

Get the exception limit categories

5 params → 200400500401403

PUT

/getConsumer/{tenantName}

Retrive consumers details

4 params body → 200400500401403

POST

/setConsumer/{tenantName}

Save consumer details

4 params body → 200400500401403

POST

/sendCommand/{tenantName}

Send command such as system shutdown, etc

4 params body → 200400500401403

GET

/statusRequest/{tenantName}

Get the status of host and server

4 params → 200400500401403

POST

/callForwarding/{tenantName}

To create a task in Twillio task router for group call.

4 params body → 200400500401403

GET

/validateToken/{tenantName}

To validate the token

4 params → 200400500401403

PUT

/cancelTask/{tenantName}

To cancel a group call in Twilio based on the given task sid.

4 params body → 200400500401403

Schemas 168

The contract defines 168 schemas that model the data the API accepts and returns. The most detailed are CounterData (31 properties), CheckDetails (23 properties), CassInfo (22 properties), CheckInCassette (18 properties). Each schema is shown below with its type and property counts.

ServiceResponse

object

2 properties 2 required

UnauthorizedServiceResponse

object

2 properties 2 required

ResponseCode

string

FailResponseCode

string

ExtendedResponse

object

2 properties 1 required

ExtendedResponseCode

string

Extended response code mapping

ExtendedResponseMessage

string

Extended response message

TenantName

string

Name of the tenant

IDToken

string

ID Token

WorkstationId

string

Workstation Id

Remarks

string

Reason for change

TransactionId

string

Transaction id

TransactionNo

string

TM Transaction Number

TerminalId

string

Terminal Id

ImageId

string

Image id

ConsumerId

string

Consumer id

CommandType

string

Command Type

CommandName

string

Command Name

CommandSendStatus

string

Status to show if command has been sent successfully to terminal

Command

object

Command to be sent

3 properties

CommandStatus

object

Statuses of commands sent

3 properties

CommandParameter

object

Command parameter

2 properties

ParameterKey

string

Parameter key

ParameterValue

string

Parameter value

TellerReadinessRequest

object

1 property

TellerStatus

string

Teller Status Type

TellerName

string

Teller Name

SendCommandMode

string

Command Modes , If controlled is used it will shutdown or restart gracefully based on command type.

Image

object

6 properties

DocumentType

string

Name of an image document

ImageValidationStatus

string

Validation status of an image

FrontImage

object

Front part of document image

2 properties

BackImage

object

Back part of document image

2 properties

ImageData

string

Base64 image data

dateTime

string

Timestamp of the description

dateTimeWithoutSeconds

string

Timestamp of the description

ExternalCustomerId

string

External customer id

TaskTimeOut

integer

Task time out for group call in seconds

ExceptionLimitTime

object

Exception limit time. Difference between from and to dates should be less than or equal to 24 hrs.

2 properties 2 required

InstituteConfiguration

object

Institute Configuration

3 properties 2 required

TwilioTaskRouterResponse

object

Twillio Task Router Token

3 properties 2 required

ServiceResponse_extendedResponse

object

2 properties 1 required

TerminalStatus

object

Get Workstation Status

3 properties 2 required

CassCounterList

array

CassCounter

object

Cassette counter details

2 properties

CounterData

object

Cassette counter details

31 properties

DocumentCounter

object

8 properties

PayableAmountInfo

object

Payable amount information

5 properties

CassCountListData

object

2 properties

WorkstationInfo

object

Workstation information

3 properties

CheckInCassette

object

Details of cassette 1

18 properties

DeviceConstant

object

Details of a given device

5 properties

SubCounterList

object

2 properties

CassInfo

object

Cassette information

22 properties

CassCountData

object

Cassette counter data

13 properties

AccountListResponse

object

Account list response

3 properties 2 required

ImageListResponse

object

Get Image response

3 properties 2 required

GetCheckImagesResponse

object

Add Check response

3 properties 2 required

CheckDetailsWithImage

object

Check details with image

CheckDetails

object

Details of checks

23 properties 1 required

CheckImage

object

Check Image

2 properties 1 required

ImageType

string

ImageType of the check

Deleted

boolean

Flag to indicate that the check is rejected or should be returned to the consumer

MediaState

string

The state of the media

CheckUpdateDate

object

Creation date or date of last update for this record

CourtesyAmount

object

Amount read by Optical Character Recognition (OCR) from the check image

PayableAmount

object

The amount which may be payed on this check

UserAmount

object

The amount which is entered by the User

ValidatedAmount

object

Amount which has been validated

MICRAmount

object

Amount read from the MICR line

RejectedBy

string

Indicates who has rejected the check

CheckType

string

The Check Type value of the check

CheckState

string

State of the check

CheckStatus

object

8 properties

Date

string

The date pattern is defined 'yyyy-MM-dd', with yyyy as 4-digit year, MM as 2-digit month and dd as 2-digit date of month

Count

integer

Count Limit specifies the aggregated business cases to be count within a defined period of time.

Amount

object

The basic type of an amount.

2 properties 2 required

AccountInfo

object

AccountInformationBase

object

Account base information

7 properties 3 required

AccountOwnership

string

The ownership of the account

AccountStatus

string

The status of the account

Loan

object

Loan balance to be represented in amounts as LOANBALANCE, INTERESTAMOUNT, REGULARPAYMENTAMOUNT, REGULARPAYMENTDUE, PRINCIPLEBALANCE, MINIMUMAMOUNTDUE, LASTPAYM…

2 properties

Credit

object

Credit amounts to be represnted in amounts as CREDITLIMIT, AVAILABLECREDIT, LASTCHARGEDUE, INTERESTPAIDYEARTODATE, INTERESTPAIDPREVIOUSYEARTODATE, INTERESTAMOU…

1 property

Payment

object

Payment amounts to be represnted in amounts as REGULARPAYMENTAMOUNT, REGULARPAYMENTDUE, PRINCIPALBALANCE, PAYOFFAMOUNT, LASTPAYMENTAMOUNT

4 properties

Warning

object

5 properties 2 required

AccountType

string

| Symbolic name | Comment | |----------------------------|----------------------------------------------------------------| | UNSPECIFIED | Default value for u…

AccountSubType

string

Represents the SubType of an account for AccountType

AccountName

string

The account name which is displayed to the user

LoanType

string

All the possible account types for LOAN Accounts

Amounts

array

Account amount

AccountAmount

object

3 properties

AccountAmountType

string

Amount types for account

ConsumerResponse

object

3 properties 2 required

ConsumerRef

string

Reference number of a consumer

AccountRef

object

2 properties

AccountNumber

string

Account number

IsOrganization

boolean

True if consumer is an organization.

TaxId

string

Tax id of a consumer

City

string

City

Country

string

Country

PostalCode

string

Postal code

StateCode

string

State code

Street

string

Street

StreetNo

string

Street

Address

object

6 properties

string

Consumer email

DateOfBirth

string

Consumer's date of birth

ConsumerType

string

Consumer type. Possible values: UNKNOWNCONSUMER, PRIVATECONSUMER, BUSINESSCONSUMER and BUSINESSRUNNER

FirstName

string

Consumer first name

MiddleName

string

Consumer middle name

LastName

string

Consumer last name

FullName

string

Consumer full name

ConsumerName

object

4 properties

PhoneNumber

string

Consumer phone number

PhoneType

string

Consumer phone type

ConsumerPhone

object

2 properties

CheckDetailsResponse

object

Check image response

2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Banking#Payments#ATM#Self-Service#Transaction Middleware#Vynamic#Remote Assistance#Kiosk

← Back to D APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=diebold-dn-assist-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/diebold-dn-assist-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of DN Assist API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

DN Assist API

Metadata

Authentication & Security 3

Paths & Operations 23

Schemas 168

Specification

Source

API Details

Provider

Explore more

Work with this as data

MCP tools for apis

Call it yourself

Get an API key