Bank Match Status

Request

This endpoint is used to check the status of a verification whose status is ‘pending’.

Security

bearerToken

Query

audition_idstringrequired

identifier to check status

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/localSolutions/FR/bankmatch/audition?audition_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

@domainstring

The domain associated with the match.

createdBystring

The user or system that created the match record.

createdDatestring, (date-time)

The date and time when the match record was created.

lastModifiedBystring

The user or system that last modified the match record.

lastModifiedDatestring, (date-time)

The date and time when the match record was last modified.

idstring

The unique identifier of the match record.

scoreinteger

The score assigned to the match.

classificationstring

The classification of the match.

statusstring

The current status of the match.

entityobject

Details of the entity involved in the match.

issuerCompanyobject

Information about the issuer company.

inputobject

Input data for the match.

withDeferredResultboolean

Indicates if the match result is deferred.

byAPIboolean

Indicates if the match was processed via API.

byFTPboolean

Indicates if the match was processed via FTP.

workflowstring

The workflow associated with the match.

reasonsArray of strings

The reasons associated with the match.

reasonLabelsobject

Labels for the reasons associated with the match.

Response

{
  "@domain": "string",
  "createdBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedBy": "string",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "score": 0,
  "classification": "string",
  "status": "string",
  "entity": {
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "paymentIdentity": { … },
    "company": { … },
    "additionalProperties": { … }
  },
  "issuerCompany": {
    "createdBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedBy": "string",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "registrationId": "string",
    "name": "string",
    "typeId": "string",
    "countryCode": "string"
  },
  "input": {
    "@input": "string",
    "paymentIdentity": { … },
    "company": { … }
  },
  "withDeferredResult": true,
  "byAPI": true,
  "byFTP": true,
  "workflow": "string",
  "reasons": [
    "string"
  ],
  "reasonLabels": {
    "property1": "string",
    "property2": "string"
  }
}