Contract registration

It includes examples of API requests with mandatory and optional fields, a comprehensive list of all available fields, common responses, and error descriptions.

To create contract:

HTTP Method: POST

Path: {{baseUrl}}/amlyze-ws-rest/contract

ContentType: application/json

Authorization: Bearer Token

To update contract:

HTTP Method: PUT

Path: {{baseUrl}}/amlyze-ws-rest/contract

ContentType: application/json

Authorization: Bearer Token

API requests example

Show Fields example | CONTRACT import

{
    "communicationNumber": "COM216a",
    "requester": "financial_institution",
    "contractType": "CREDIT_CARD",
	"businessUnit": "sandbox",
    "extId": "any_contract_1232",
    "contractCode": "REG74121101",
    "customerExtId": "ORG20231117550"
}

Fields

communicationNumber

string

required

Unique number of communication. It is used for risk assessment callback. This field can store up to 256 characters.

Example: ComNr_000321

requester

string

required

Name of the system requesting web service.

Example: financial_institution

action

string from enum

Important: This field is only be included when using batch API. Element is used to create/update data of the contract. As this field is not mandatory and if not provided, CREATE values is set as default.

❗ By UPDATEing, all data will be replaced with newly received one

Enum class values: CREATE, UPDATE

Example: UPDATE

active

Boolean

A contract is active or not.

Example: true

contractType

string from classifier list

Type of contract for evaluation of the object.

💡 Possible values will be updated during configuration period.

💡 [AdditionalProperty] fields should be validated against classifier.

Example: LOAN_CONTRACT

Show Path to extract classifier values

HTTP Method: GET

Path: {{baseUrl}}/classifier/contractType

extId

string

required

Unique external contract identifier. The identifier corresponds to the contract identifier in the financial institution

Example: any_contract_1232

contractCode

string

Contract code or number.

Example: REG74121101

customerExtId

string

External customer identifier. ThiscustomerExtIdlinks a contract to customer. The identifier corresponds to the client’s identifier in the financial institution.

Example: cust_1232

accountExtId

string

External account identification number. Corresponds to the account’s identifier in the financial institution.

Example: Acc_0011

businessUnit

string from classifier list

This parameter is mandatory only for clients utilizing a multi-organizational solution. ❗Omit this parameter unless instructed about it.❗ It serves to specify the unique identifier for the business unit. Business units are logical groupings of users and data. Each business unit can have its own set of users, permissions, and data access rules. (Upcoming feature)

Example: LOAN_CONTRACT

Show BUSINESS_UNIT_NAME

HTTP Method: GET

Path: {{baseUrl}}/classifier/businessUnit

startAt

date

Contract start date or any other date that covers starting point.

Example: 2000-01-03

endAt

date

Contract end date or any other date that covers ending point.

Example: 1995-05-24

additionalProperties

list[]

required

Additional properties for contract.

Show additionalProperties list[] fields

code

string

required

Unique code.

Example: 'interest' | 'agency' | 'status' | 'principal_amount'

title

string

required

Description, what kind of data is stored here.

Example: Human readable title.

value

string

Value of field.

Example: 10000

dataType

string, integer, decimal, date, timestamp, boolean, external link

Data type.

Example: STRING

Timestamp RFC 3339 (ISO 8601)

The date and time of a property.

Example: 2024-05-26T16:49:50.237

List of possible responses

This part lists common responses after the submission of the request.

200 OK
{
  "resultType": "REQUEST_ACCEPTED"
}

400 Bad Request
{
  "resultType": "REQUEST_REJECTED",
  "errorCode": "O001",
  "errorDescription": "extId is mandatory"
}

404 Not Found
{
  "timestamp": "2024-05-26T16:49:50.237+00:00",
  "status": 404,
  "error": "Not Found",
  "path": "/amlyze-ws-rest/contract" //--> mistake inside the endpoint
}

500 Internal Server Error
{
  "resultType": "REQUEST_REJECTED",
  "status": 500,
  "error": "Internal Server Error"
}

List of possible errors

This section lists the possible errors that can occur when making a bad account request to the API. A bad request is a request that somehow does not follow the API specifications.


extId is mandatory
code is mandatory

On this page

API requests example
Fields
List of possible responses
List of possible errors

It includes examples of API requests with mandatory and optional fields, a comprehensive list of all available fields, common responses, and error descriptions.

To create contract:

HTTP Method: POST

Path: {{baseUrl}}/amlyze-ws-rest/contract

ContentType: application/json

Authorization: Bearer Token

To update contract:

HTTP Method: PUT

Path: {{baseUrl}}/amlyze-ws-rest/contract

ContentType: application/json

Authorization: Bearer Token

API requests example

Show Fields example | CONTRACT import

{
    "communicationNumber": "COM216a",
    "requester": "financial_institution",
    "contractType": "CREDIT_CARD",
	"businessUnit": "sandbox",
    "extId": "any_contract_1232",
    "contractCode": "REG74121101",
    "customerExtId": "ORG20231117550"
}

Fields

communicationNumber

string

required

Unique number of communication. It is used for risk assessment callback. This field can store up to 256 characters.

Example: ComNr_000321

requester

string

required

Name of the system requesting web service.

Example: financial_institution

action

string from enum

❗ By UPDATEing, all data will be replaced with newly received one

Enum class values: CREATE, UPDATE

Example: UPDATE

active

Boolean

A contract is active or not.

Example: true

contractType

string from classifier list

Type of contract for evaluation of the object.

💡 Possible values will be updated during configuration period.

💡 [AdditionalProperty] fields should be validated against classifier.

Example: LOAN_CONTRACT

Show Path to extract classifier values

HTTP Method: GET

Path: {{baseUrl}}/classifier/contractType

extId

string

required

Unique external contract identifier. The identifier corresponds to the contract identifier in the financial institution

Example: any_contract_1232

contractCode

string

Contract code or number.

Example: REG74121101

customerExtId

string

External customer identifier. ThiscustomerExtIdlinks a contract to customer. The identifier corresponds to the client’s identifier in the financial institution.

Example: cust_1232

accountExtId

string

External account identification number. Corresponds to the account’s identifier in the financial institution.

Example: Acc_0011

businessUnit

string from classifier list

Example: LOAN_CONTRACT

Show BUSINESS_UNIT_NAME

HTTP Method: GET

Path: {{baseUrl}}/classifier/businessUnit

startAt

date

Contract start date or any other date that covers starting point.

Example: 2000-01-03

endAt

date

Contract end date or any other date that covers ending point.

Example: 1995-05-24

additionalProperties

list[]

required

Additional properties for contract.

Show additionalProperties list[] fields

code

string

required

Unique code.

Example: 'interest' | 'agency' | 'status' | 'principal_amount'

title

string

required

Description, what kind of data is stored here.

Example: Human readable title.

value

string

Value of field.

Example: 10000

dataType

string, integer, decimal, date, timestamp, boolean, external link

Data type.

Example: STRING

Timestamp RFC 3339 (ISO 8601)

The date and time of a property.

Example: 2024-05-26T16:49:50.237

List of possible responses

This part lists common responses after the submission of the request.

200 OK
{
  "resultType": "REQUEST_ACCEPTED"
}

400 Bad Request
{
  "resultType": "REQUEST_REJECTED",
  "errorCode": "O001",
  "errorDescription": "extId is mandatory"
}

404 Not Found
{
  "timestamp": "2024-05-26T16:49:50.237+00:00",
  "status": 404,
  "error": "Not Found",
  "path": "/amlyze-ws-rest/contract" //--> mistake inside the endpoint
}

500 Internal Server Error
{
  "resultType": "REQUEST_REJECTED",
  "status": 500,
  "error": "Internal Server Error"
}

List of possible errors

This section lists the possible errors that can occur when making a bad account request to the API. A bad request is a request that somehow does not follow the API specifications.


extId is mandatory
code is mandatory

On this page

API requests example
Fields
List of possible responses
List of possible errors

​API requests example

​Fields

​List of possible responses

​List of possible errors

API Documentation

​API requests example

​Fields

​List of possible responses

​List of possible errors

API requests example

Fields

List of possible responses

List of possible errors

API requests example

Fields

List of possible responses

List of possible errors