v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB
Onboarding Services

Get Status

API to get the status of the onboarding

get/v1/onboarding/{id}

Path parameters

idstring required

Either evaluation ID returned by api on evaluation or reference id sent by client on evaluation

Query parameters

field'ONBOARDING_ID' | 'REFERENCE_ID'

Name that indicates which id we are going to use to look up the case (onboarding_id or reference_id). Optional and by default its value is onboarding_id. When uses a reference_id the query param "field" must be added with the value REFERENCE_ID.

Response

Antifraud analysis status response

onboardingIdstring required

Onboarding identification

referenceIdstring required

Client transaction identifier

status'PENDING' | 'INPROGRESS' | 'ACTIONREQUIRED' | 'COMPLETED' | 'REJECT' | 'CANCELLED' required

Onboarding status

messagestring

Information message

Example response

{
  "onboardingId": "31ff2cc8-199e-4c3c-ba2d-4d85b88bd9f2",
  "referenceId": "FGCCCEA53JYSHXX",
  "message": "Test message",
  "credentials": {
    "storeCode": "STORE12",
    "privateKey": "dqwg43yefnjnk5fe",
    "orgId": "s4fes6ytr4"
  },
  "paymentAccounts": [
    {
      "account": "AP12345PI",
      "evaluatesFraud": true
    }
  ]
}