CARMA

API. Developer guide

APIKeyHeader

This is the most secure authorization type and the one with the most flexibility.

API keys can generate by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can revoke at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Authorization: App b546e-y59a-e931-478d-ji87-28a67
Security scheme type:API Key
Header parameter name:  Authorization

All use cases can be achieved by using this API method. Everything from sending a simple single request, up to batch sending of requests with a single API request.

Integration essentials and developer toolbox

POST    /api/request

Base URL: Please login to see full path.

AUTHORIZATIONS:     APIKeyHeader
REQUEST BODY SCHEMAapplication/json
Parameters typeDescribe
type_requeststringIndicator of the type of information that we are looking for in this request. Possible values: “client”, “client full”, “loan”, “loan full”, “payments”, “purchase history”, “subscription”, “blacklist”, “public source”, “credit history”
value Array of objectsAll information identification of all request.
 requestArray of objectsthis block stores information about a unique request
 Id_documentstringID/Number document of person. Used in the block “request”
 phonesrtingPhone number of person. Can use next format ‘+380999999999’ or ‘380999999999’ or ‘0999999999’’. Used in the block “request”

Example

{
      ‘type_request’ : {‘client’,’ blacklist’},
      ‘value’ :  {
         ‘request’  :  {‘Id_document’ : ‘NK5673-567’,
                        ‘phone’ : ’+380660941201’} ,
         ‘request’  :  {‘ Id_document’ : ‘TR6223-34’}
      },
}

 Default successful response

Answer BODY SCHEMAapplication/json
Parameters typeDescribe
type_requeststringIndicator of the type of information that we are looking for in this request. Possible values: “client”, “client full”, “loan”, “loan full”, “payments”, “purchase history”, “subscription”, “blacklist”, “public source”, “credit history”
value Array of objectsAll information identification of all request.
 requestArray of objectsthis block stores information about a unique request
 idrequeststringSystem id for request
 valueArray of objectsAll filters for unique request

Example

{
      ‘type_request’ : {‘client’, ‘blacklist’},
      ‘value’:  {
            ‘request’  :  {
                   ‘Idrequest’: ’qw2wws-wewe3-23dd3-2112w’,
                   ‘value’:{‘Id_document’ : ‘NK5673-567’,
                            ‘phone’ : ’+380660941201’}
             },
             ‘request’  :  {
                  ‘Idrequest’: ‘89jb6-y78y-23dd3-0iejf8’,
                  ‘value’:{ ‘Id_document’ : ‘TR6223-34’}
             }
       },
}

Default error response

ParametersType
requestErrorobject (ApiRequestError)
 serviceExceptionobject (ApiRequestErrorDetails)
 additionalDescriptionstring
variablesstring
messageIdstring
textstring

All use cases can be achieved by using this API method. Everything from getting an answer of a simple single request, up to batch sending of requests with a single API request.

Integration essentials and developer toolbox

POST    /api/respond

Base URL: Please login to see full path.

AUTHORIZATIONS:     APIKeyHeader
REQUEST BODY SCHEMAapplication/json
ParametersTypeDescribe
type_requeststringIndicator of the type of information that we are looking for in this request. Possible values: “client”, “client full”, “loan”, “loan full”, “payments”, “purchase history”, “subscription”, “blacklist”, “public source”, “credit history”
id_request Array of  stringArray of Id request
periodnumber

Time span in n minutes.

As a result, the results of all queries for the last n minutes will be return.

Example

{
       ‘type_request’ : ‘client’,
       ‘id_request’: {’qw2wws-wewe3-23dd3-2112w’’,”89jb6-y78y-23dd3-0iejf8”}
}

Or

{
       ‘type_request’ : ‘client’,
       ‘iperiod: ‘10’
}

Default successful response

Answer BODY SCHEMAapplication/json
ParameterstypeDescribe
type_requeststringIndicator of the type of information that we are looking for in this request. Possible values: “client”, “client full”, “loan”, “loan full”, “payments”, “purchase history”, “subscription”, “blacklist”, “public source”, “credit history”
answerArray of objectArray of all answers of requests
 requestArray of objectthis block stores information about a unique request
 id_requeststringUnique request id.
idpeersstringUnique pear’s id.
datasetnumberThe amount of information that was analyze at the peer.
valueArray of objectThis block stores answer.
 Id_documentstringDetails of basic credential (national passport etc.)
phonenumberPersonal phone number. Value format – ‘0979999999’
alternative idstringDetails of any type of alternative credentials that could use to identify a person (international ID etc.). This field is returned when available upon request with type “client” and “client full”
driving licensestringDetails of a driving license. This field is returned when available upon request with type “client” and “client full”
first namestringFirst Name. This field is returned when available upon request with type “client” and “client full”
last namestringLast Name. This field is returned when available upon request with type “client” and “client full”
sexstringSex. This field is returned when available upon request with type “client” and “client full”
educationstringGraduation. This field is returned when available upon request with type “client full”
marital statusstringMarital Status. This field is returned when available upon request with type “client full”
childrennumberQuantity of children in family. This field is returned when available upon request with type “client full”
dependentsnumberQuantity of dependents in family, the members without income. This field is returned when available upon request with type “client full”
employmentstringCurrent employment status. This field is returned when available upon request with type “client full”
occupationstringOccupation Industry. This field is returned when available upon request with type “client full”
job functionsstringJob Functions. This field is returned when available upon request with type “client full”
job senioritystringJob Seniority. This field is returned when available upon request with type “client full”
years of experiencenumberYears of Experience. This field is returned when available upon request with type “client full”
income frequencystringIncome frequency. This field is returned when available upon request with type “client” and “client full”
income amountstringIncome amount. This field is returned when available upon request with type “client” and “client full”
income currencystringIncome currency. This field is returned when available upon request with type “client” and “client full”
secondary phone numberstringSecond phone number or number belongs to close reletives. This field is returned when available upon request with type “client” and “client full”
alternative phone numberstringPhone number person who can help to contact. This field is returned when available upon request with type “client” and “client full”
primary address linestringStreet, building, room of primary accommodation. This field is returned when available upon request with type “client” and “client full”
primary townstringCity of primary accommodation. This field is returned when available upon request with type “client” and “client full”
primary countrystringCountry of primary accommodation. This field is returned when available upon request with type “client” and “client full”
primary zip codestringZip code of primary accommodation. This field is returned when available upon request with type “client” and “client full”
primary geolocationstringGeolocation of primary accommodation. This field is returned when available upon request with type “client” and “client full”
secondary address linestringStreet, building, room of secondary accommodation. This field is returned when available upon request with type “client full”
secondary townstringCity of secondary accommodation. This field is returned when available upon request with type “client full”
secondary countrystringCountry of secondary accommodation. This field is returned when available upon request with type “client full”
secondary zip codestringZip code of secondary accommodation. This field is returned when available upon request with type “client full”
secondary geolocationstringGeolocation of secondary accommodation. This field is returned when available upon request with type “client full”
type of servicestringDescription of regularity for made payments. This field is returned when available upon request with type “payments”
provider typestringType of a company provided information. This field is returned when available upon request with type “payments”
payment datedate timePayment date in UTC-0. This field is returned when available upon request with type “payments”
payment amountmoneyPayment amount. This field is returned when available upon request with type “payments”
payment currencystringPayment currency. This field is returned when available upon request with type “payments”
paid totalmoneyCumulative amount paid historically. This field is returned when available upon request with type “purchase history”
first purchase datedate timeFirst Purchase Date in UTC-0. This field is returned when available upon request with type “purchase history”
subscription start datedate timeSubscription entry date in UTC-0.This field is returned when available upon request with type “subscription”
paid totalmoneyCumulative amount paid historically. This field is returned when available upon request with type “subscription”
subscription statusstringSubscription Status. This field is returned when available upon request with type “subscription”
subscription amountmoneyAmount to be regularly paid. This field is returned when available upon request with type “subscription”
subscription overduemoneyOverdue Status. This field is returned when available upon request with type “subscription”
subscription dpdmoneySubscription Days past Due. This field is returned when available upon request with type “subscription”
balancemoneyCurrent balance. This field is returned when available upon request with type “subscription”
blacklist statusstringIn the blacklist? This field is returned when available upon request with type “blacklist”
blacklist causestringStory caused blacklisting. This field is returned when available upon request with type “blacklist”
blacklist datedate timeEntry date for blacklist in UTC-0. This field is returned when available upon request with type “blacklist”
blacklist expelldate timeRemoval date from blacklist in UTC-0. This field is returned when available upon request with type “blacklist”
criminal databasestringList of Sentenced Persons. This field is returned when available upon request with type “public source”
realty registrystringRegistered Realty. This field is returned when available upon request with type “public source”
assets registrystringRegistered Assets. This field is returned when available upon request with type “public source”
loan inquiry datedate timeLoan Date Inquiry in UTC-0. This field is returned when available upon request with type “loan” and “loan full”
loan inquiry amountmoneyRequested amount to borrow. This field is returned when available upon request with type “loan” and “loan full”
loan inquiry purposestringLending Purpose. This field is returned when available upon request with type “loan” and “loan full”
loan inquiry application methodstringMethod of application. This field is returned when available upon request with type “loan” and “loan full”
loan inquiry currencystringLoan Inquiry Currency. This field is returned when available upon request with type “loan” and “loan full”
loan purposestringLending Purpose. This field is returned when available upon request with type “loan full”
loan principalmoneyLanded amount. This field is returned when available upon request with type “loan full”
loan balancemoneyActual balance. This field is returned when available upon request with type “loan full”
loan statusstringLoan Status. This field is returned when available upon request with type “loan full”
loan open datedate timeDate of loan disbursement UTC-0. This field is returned when available upon request with type “loan full”
loan last paymentdate timeDate of last payment for loan in UTC-0. This field is returned when available upon request with type “loan full”
loan paid-off amountmoneyAggregated Amount of Payments Paid. This field is returned when available upon request with type “loan full”
loan delinquency statusstringDebt Collection Status. This field is returned when available upon request with type “loan full”
credit history loansnumberQuantity of approved loans historically. This field is returned when available upon request with type “credit history”
credit history amountmoneyAmount landed historically in local currency. This field is returned when available upon request with type “credit history”
credit history paymentsmoneyAmount paid off historically in local currency. This field is returned when available upon request with type “credit history”
credit history currencystringLocal currency. This field is returned when available upon request with type “credit history”
credit ratingstringInternal Credit Rating. This field is returned when available upon request with type “credit history”

Example

{
       ‘type_request’ : ‘client’,
       ‘answer’ : {
              ‘request’ : {
                     ‘id_request’: ’qw2wws-wewe3-23dd3-2112w’,
                     ‘idpeers’ : ‘TS1’,
                     ‘dataset’ : ‘12706’,
                     ‘value’ :  {
                            ‘phone’: ’0660941201’ ,
                            ‘id document’: ’3232345322’,
blacklist status’: ’yes’,
Blacklist date’: ‘2019-09-19’
                     }
              },
              ‘request’ : {
                     ‘id_request’: ’89jb6-y78y-23dd3-0iejf8’,
                     ‘value’ :  {‘information not found’}
              }
       }
}

Default error response

ParametersType
requestErrorobject (ApiRequestError)
 serviceExceptionobject (ApiRequestErrorDetails)
 additionalDescriptionstring
variablesstring
messageIdstring
textstring