API used for marketplace business to customer integration into MFC Non Dealer Direct application
Paths
/intent
Create an pre-qualification request
Submit an intent for a pre-qualification request
TPP client credential authorisation flow with the ASPSP
Create intent request
The produced content type. Must be 'application/json'.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Header containig a detached JWS signature of the body of the payload.
Created
Any HTTP status code other than a 200 will indicate that an error has occurred
{
"schema": {
"type": "object"
}
}/prequalifications
Request a pre-qualification check. This includes a credit check for the specified client information as well as indicative vehicle finance values
Pre-qualification request of the authenticated Customer
TPP client credential authorisation flow with the ASPSP
The produced content type. Must be 'application/json'.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
The request object containing the required PreQualifications information
{
"default": true
}Any HTTP status code other than a 200 will indicate that an error has occurred
{
"schema": {
"type": "object"
}
}/mfcauthorize
Definitions
{
"properties": {
"cellphone": {
"type": "string"
},
"firstName": {
"type": "string"
},
"identityNumber": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"netSalary": {
"format": "double",
"type": "number"
},
"totalExpenses": {
"format": "double",
"type": "number"
},
"desiredAmount": {
"format": "double",
"type": "number"
}
},
"required": [
"cellphone",
"firstName",
"identityNumber",
"lastName",
"email",
"netSalary",
"totalExpenses"
],
"type": "object"
}
{
"properties": {
"data": {
"$ref": "#/definitions/IntentRequestMessageData"
},
"risk": {
"$ref": "#/definitions/IntentRisk"
}
},
"additionalProperties": false,
"required": [
"data",
"risk"
]
}
{
"title": "Data",
"properties": {
"permissions": {
"$ref": "#/definitions/IntentPermissions"
},
"expirationDateTime": {
"$ref": "#/definitions/IntentExpirationDateTime"
}
},
"additionalProperties": false,
"required": [
"permissions"
]
}
{
"properties": {
"data": {
"$ref": "#/definitions/IntentResponseMessageData"
},
"risk": {
"$ref": "#/definitions/IntentRisk"
},
"links": {
"$ref": "#/definitions/IntentResponseMessageLinks"
},
"meta": {
"$ref": "#/definitions/IntentResponseMessageMeta"
}
},
"additionalProperties": false,
"required": [
"data",
"links",
"meta"
]
}
{
"title": "Data",
"properties": {
"intentId": {
"description": "Unique identification as assigned to identify the PreQualifications request resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"permissions": {
"$ref": "#/definitions/IntentPermissions"
},
"status": {
"type": "string",
"description": "Specifies the status of the PreQualifications request resource. - Authorised - AwaitingAuthorisation - Rejected - Revoked"
},
"creationDateTime": {
"description": "Date and time at which the resource was created.",
"type": "string",
"format": "date-time"
},
"expirationDateTime": {
"$ref": "#/definitions/IntentExpirationDateTime"
}
},
"type": "object",
"required": [
"intentId",
"creationDateTime"
],
"additionalProperties": false
}
Meta Data relevant to the payload
{
"title": "Meta",
"type": "object",
"properties": {
"total-pages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
{
"properties": {
"data": {
"$ref": "#/definitions/PreQualificationRequestMessage"
},
"meta": {
"$ref": "#/definitions/ApiMetaData"
},
"links": {
"$ref": "#/definitions/IntentResponseMessageLinks"
}
},
"required": [
"meta",
"links"
],
"type": "object"
}
Links relevant to the payload
{
"title": "Links",
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"first": {
"type": "string",
"format": "uri"
},
"prev": {
"type": "string",
"format": "uri"
},
"next": {
"type": "string",
"format": "uri"
},
"last": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false,
"required": [
"self"
]
}
Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.
{
"title": "ExpirationDateTime",
"type": "string",
"format": "date-time"
}
Specifies the Open Banking pre-qualification request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.
{
"title": "permissions",
"type": "array",
"items": {
"type": "string",
"description": "Specifies the pre-qualification request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. - PerfomCreditCheckConsent"
},
"minProperties": 1,
"additionalProperties": false
}
The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for PreQualifications Info.
{
"properties": [],
"additionalProperties": false
}
Meta Data relevant to the payload
{
"title": "Meta Data",
"type": "object",
"properties": {
"code": {
"type": "string"
},
"debugInfo": {
"$ref": "#/definitions/ArrayOfString"
},
"detail": {
"type": "string"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"total-pages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
{
"items": {
"type": "string"
},
"type": "array"
}