Skip to main content

Credit Check for Corporate Customer

Description:
CreditThis checkAPI performs a credit assessment for a corporate customer by organizationId.

Authentication

This endpoint requires authentication using (a Bearer Token. The client must send the token in the Authorization header for every request.

Example Authentication Header:

Authorization: Bearer YOUR_ACCESS_TOKEN

If the token is missingbusiness or invalid,company) thebased APIon willits returnorganization 401 Unauthorized response.number.


Endpoint

POST 

Authorization

To

access

Send

A

successful
Endpoint:https://demo-api.frontpayment.no/api/v1/connect//credit/check/corporate
Method: POST
Authentication:Bearer
Payload Validation:
'organizationId' => 'required|string'

this endpoint, include a Bearer Token in the Authorization header of your request. You can obtain this token from Frontpayment.

Example Authorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Request Payload

:the following parameters as a JSON object in the request body:

{
    "organizationId": "998379342"993344228",
}

Validation Rules

Make sure your request meets the following requirements:

FieldTypeDescription
organizationIdstringRequired The official organization number of the company.

Response

Structure
:request will return a 200 OK status with the following JSON payload:

{
    "status_code": "integer",
    "status_message": "String",
    "message": "String",
    "is_data": "Boolean",
    "data": "Array"
}
Example Response:
{
    "status_code": 200,
    "status_message": "OK",
    "message": "creditCheckRequestedSuccessful",
    "is_data": false,
    "data": null
}

API returns a 500 or 510 error, it means something failed on the server side

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "personCurrentStatusIsWrong"somethingWentWrong",
    "is_error": true,
    "errors": "Ugyldig fødselsnummer"Array"
}