The ONBOARDING object

Temps estimé :12 minutes

ONBOARDING_ENROLLMENT_CREATED
When the onboarding request has been accept. You will receive an enrollementId associated to you custom reference.

{
  "eventId": "8eb9f549-325d-4451-8e98-d90f1bf5635a",
  "type": "ONBOARDING_ENROLLMENT_CREATED",
  "creationDate": "2024-01-10T09:14:51.488392+01:00",
  "object": {
    "workflow": {
      "uuid": "b1161973-7ec2-4dd0-a23e-abb788b68844",
      "status": "ON_GOING",
      "activities": [
        {
          "step_elements": [],
          "uuid": "e08b0baf-c947-4b82-bd69-f98a2a67c511",
          "name": "ContractValiA",
          "state": "TODO",
          "category": "validation",
          "created_at": "2024-01-10T09:14:51"
        }
      ],
      "additional_documents": []
    },
    "identity_badge": null,
    "representatives_list": null,
    "inactive_representatives_list": [],
    "infogreffe_identity": null,
    "language": "fr",
    "risk_score": {
      "activity": 2,
      "activity_age": null,
      "turnover": 1,
      "bank_account": 0,
      "total": null
    },
    "additional_document_need_upload": false,
    "uuid": "c2e03650-2427-4c25-aa31-016c63f7261b",
    "risk_points": null,
    "created_at": "2024-01-10T09:14:51",
    "last_updated_at": null,
    "turnover_is_fixed": false,
    "workflow_mode": "SEQUENTIAL",
    "risk_level": "LOW",
    "type": "INDIVIDUAL",
    "is_canceled": false,
    "enrollment_account": null,
    "profile": {
      "birthname": {
        "status": "ON_GOING",
        "uuid": "a60a7930-38ce-4585-bc15-bad4e4d8c9fa",
        "value": null,
        "element-type": "birthname"
      },
      "uuid": "805a41ad-bd70-4841-a0d4-91f9082860dd",
      "workflow": {
        "uuid": "24d6e160-5f16-4e60-81a2-f5b6942ce629",
        "status": "ON_GOING",
        "activities": [
          {
            "step_elements": [
              {
                "status": "COMPLETED",
                "uuid": "76fa0a86-7b3e-44e5-aa8a-f6ccd06d3df9",
                "value": "Carmelo",
                "element-type": "firstname"
              },
              {
                "status": "COMPLETED",
                "uuid": "f01070cd-01c8-4e22-929a-7988c2c0dac0",
                "value": "Littel",
                "element-type": "lastname"
              },
              {
                "status": "COMPLETED",
                "uuid": "41449fa2-079e-4f1e-81b2-a4fed78c1d5b",
                "value": "verna11@yahoo.com",
                "element-type": "email"
              },
              {
                "status": "COMPLETED",
                "uuid": "8899cbdc-f074-4730-9f9e-44a144517a39",
                "value": "+3300000000",
                "element-type": "phone"
              },
              {
                "status": "COMPLETED",
                "uuid": "9ce4c8fb-3c39-4e42-bc81-45a78760d8ff",
                "value": "1993-01-01T00:00:00",
                "element-type": "birthday"
              },
              {
                "status": "COMPLETED",
                "uuid": "37ec9115-e88f-4bd7-a36e-77c4204f5058",
                "value": "Tours",
                "element-type": "place-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "898c972f-be5f-4209-b9a6-4b06ed8e17f9",
                "country": "FRA",
                "element-type": "country-of-birth"
              }
            ],
            "uuid": "adf915df-d11f-4862-b76d-1c1e4e06994d",
            "name": "identityInfos",
            "state": "TODO",
            "category": "identity",
            "created_at": "2024-01-10T09:14:51"
          }
        ],
        "additional_documents": []
      },
      "firstname": {
        "status": "COMPLETED",
        "uuid": "76fa0a86-7b3e-44e5-aa8a-f6ccd06d3df9",
        "value": "Carmelo",
        "element-type": "firstname"
      },
      "lastname": {
        "status": "COMPLETED",
        "uuid": "f01070cd-01c8-4e22-929a-7988c2c0dac0",
        "value": "Littel",
        "element-type": "lastname"
      },
      "usename": {
        "status": "ON_GOING",
        "uuid": "a60a7930-38ce-4585-bc15-bad4e4d8c9fa",
        "value": null,
        "element-type": "birthname"
      },
      "email": {
        "status": "COMPLETED",
        "uuid": "41449fa2-079e-4f1e-81b2-a4fed78c1d5b",
        "value": "verna11@yahoo.com",
        "element-type": "email"
      },
      "language": {
        "status": "ON_GOING",
        "uuid": "78daf0f6-4659-461f-a817-72c4b233cd70",
        "locale": {
          "identifier": "fr"
        },
        "element-type": "language"
      },
      "phone": {
        "status": "COMPLETED",
        "uuid": "8899cbdc-f074-4730-9f9e-44a144517a39",
        "value": "+3300000000",
        "element-type": "phone"
      },
      "birthday": {
        "status": "COMPLETED",
        "uuid": "9ce4c8fb-3c39-4e42-bc81-45a78760d8ff",
        "value": "1993-01-01T00:00:00",
        "element-type": "birthday"
      },
      "login": null,
      "bo_user_uuid": null
    },
    "activity_sector": {
      "name": "Artisans (plumber, electricians, ...)"
    },
    "data": {
      "type": "PARTICULAR",
      "company_name": null,
      "history": [],
      "turnover": {
        "name": "Less than 20k EUR"
      },
      "activity_age": null
    },
    "custom_reference": null,
    "is_converted": false,
    "conformity_status": "ON_GOING",
    "conformity_status_level_two": null,
    "comments_level_two": null,
    "validator_level_one": null,
    "validator_level_two": null,
    "merchant_uuid": null,
    "validation_date": null,
    "validation_date_level_two": null,
    "sub_type": null,
    "api_infogreffe_attempt": 0,
    "next_step": 0,
    "full_kyc": false
  },
  "requestId": "b59cf6d0-4180-4a0e-b26d-8d2e34759c46"
}

ONBOARDING_ENROLLMENT_STATUS_UPDATED
An ongoing onboarding has been updated.

{
  "eventId": "e4e42e20-1819-49d3-af96-9a7ecb978a5d",
  "type": "ONBOARDING_ENROLLMENT_STATUS_UPDATED",
  "creationDate": "2024-01-10T09:16:02.927117+01:00",
  "object": {
    "workflow": {
      "uuid": "b1161973-7ec2-4dd0-a23e-abb788b68844",
      "status": "ON_GOING",
      "activities": [
        {
          "step_elements": [],
          "uuid": "e08b0baf-c947-4b82-bd69-f98a2a67c511",
          "name": "ContractValiA",
          "state": "TODO",
          "category": "validation",
          "created_at": "2024-01-10T09:14:51"
        }
      ],
      "additional_documents": []
    },
    "identity_badge": null,
    "representatives_list": null,
    "inactive_representatives_list": [],
    "infogreffe_identity": null,
    "language": "fr",
    "risk_score": {
      "activity": 2,
      "activity_age": null,
      "turnover": 1,
      "bank_account": 0,
      "total": null
    },
    "additional_document_need_upload": false,
    "uuid": "c2e03650-2427-4c25-aa31-016c63f7261b",
    "risk_points": null,
    "created_at": "2024-01-10T09:14:51",
    "last_updated_at": "2024-01-10T09:16:02",
    "turnover_is_fixed": false,
    "workflow_mode": "SEQUENTIAL",
    "risk_level": "LOW",
    "type": "INDIVIDUAL",
    "is_canceled": false,
    "enrollment_account": null,
    "profile": {
      "birthname": {
        "status": "ON_GOING",
        "uuid": "a60a7930-38ce-4585-bc15-bad4e4d8c9fa",
        "value": null,
        "element-type": "birthname"
      },
      "uuid": "805a41ad-bd70-4841-a0d4-91f9082860dd",
      "workflow": {
        "uuid": "24d6e160-5f16-4e60-81a2-f5b6942ce629",
        "status": "ACCEPTED",
        "activities": [
          {
            "step_elements": [
              {
                "status": "COMPLETED",
                "uuid": "76fa0a86-7b3e-44e5-aa8a-f6ccd06d3df9",
                "value": "Carmelo",
                "element-type": "firstname"
              },
              {
                "status": "COMPLETED",
                "uuid": "898c972f-be5f-4209-b9a6-4b06ed8e17f9",
                "country": "FRA",
                "element-type": "country-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "9ce4c8fb-3c39-4e42-bc81-45a78760d8ff",
                "value": "1993-01-01T00:00:00",
                "element-type": "birthday"
              },
              {
                "status": "COMPLETED",
                "uuid": "8899cbdc-f074-4730-9f9e-44a144517a39",
                "value": "+3300000000",
                "element-type": "phone"
              },
              {
                "status": "COMPLETED",
                "uuid": "f01070cd-01c8-4e22-929a-7988c2c0dac0",
                "value": "Littel",
                "element-type": "lastname"
              },
              {
                "status": "COMPLETED",
                "uuid": "37ec9115-e88f-4bd7-a36e-77c4204f5058",
                "value": "Tours",
                "element-type": "place-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "41449fa2-079e-4f1e-81b2-a4fed78c1d5b",
                "value": "verna11@yahoo.com",
                "element-type": "email"
              },
              {
                "status": "COMPLETED",
                "uuid": "76fa0a86-7b3e-44e5-aa8a-f6ccd06d3df9",
                "value": "Carmelo",
                "element-type": "firstname"
              },
              {
                "status": "COMPLETED",
                "uuid": "f01070cd-01c8-4e22-929a-7988c2c0dac0",
                "value": "Littel",
                "element-type": "lastname"
              },
              {
                "status": "COMPLETED",
                "uuid": "41449fa2-079e-4f1e-81b2-a4fed78c1d5b",
                "value": "verna11@yahoo.com",
                "element-type": "email"
              },
              {
                "status": "COMPLETED",
                "uuid": "8899cbdc-f074-4730-9f9e-44a144517a39",
                "value": "+3300000000",
                "element-type": "phone"
              },
              {
                "status": "COMPLETED",
                "uuid": "9ce4c8fb-3c39-4e42-bc81-45a78760d8ff",
                "value": "1993-01-01T00:00:00",
                "element-type": "birthday"
              },
              {
                "status": "COMPLETED",
                "uuid": "37ec9115-e88f-4bd7-a36e-77c4204f5058",
                "value": "Tours",
                "element-type": "place-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "898c972f-be5f-4209-b9a6-4b06ed8e17f9",
                "country": "FRA",
                "element-type": "country-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "08942994-180a-469e-9139-fa2fa09375ec",
                "documents": [
                  {
                    "file_check": null
                  }
                ],
                "type": "PASSPORT",
                "proof_of_identity_document": null,
                "expiry_date": null,
                "document_number": null,
                "mrz_line1": null,
                "mrz_line2": null,
                "issuing_country": null,
                "element-type": "identity-document"
              },
              {
                "status": "COMPLETED",
                "uuid": "01994746-c538-4387-a07d-af53b40e797d",
                "name_line1": "rue du bois",
                "name_line2": null,
                "name_line3": null,
                "name_line4": null,
                "locality": "Tours",
                "postal_code": "37000",
                "country": "FRA",
                "element-type": "address"
              }
            ],
            "uuid": "adf915df-d11f-4862-b76d-1c1e4e06994d",
            "name": "identityInfos",
            "state": "OK",
            "category": "identity",
            "created_at": "2024-01-10T09:14:51"
          },
          {
            "step_elements": [],
            "uuid": null,
            "name": "finished",
            "state": "OK",
            "category": null,
            "created_at": null
          }
        ],
        "additional_documents": []
      },
      "firstname": {
        "status": "COMPLETED",
        "uuid": "76fa0a86-7b3e-44e5-aa8a-f6ccd06d3df9",
        "value": "Carmelo",
        "element-type": "firstname"
      },
      "lastname": {
        "status": "COMPLETED",
        "uuid": "f01070cd-01c8-4e22-929a-7988c2c0dac0",
        "value": "Littel",
        "element-type": "lastname"
      },
      "usename": {
        "status": "ON_GOING",
        "uuid": "a60a7930-38ce-4585-bc15-bad4e4d8c9fa",
        "value": null,
        "element-type": "birthname"
      },
      "email": {
        "status": "COMPLETED",
        "uuid": "41449fa2-079e-4f1e-81b2-a4fed78c1d5b",
        "value": "verna11@yahoo.com",
        "element-type": "email"
      },
      "language": {
        "status": "ON_GOING",
        "uuid": "78daf0f6-4659-461f-a817-72c4b233cd70",
        "locale": {
          "identifier": "fr"
        },
        "element-type": "language"
      },
      "phone": {
        "status": "COMPLETED",
        "uuid": "8899cbdc-f074-4730-9f9e-44a144517a39",
        "value": "+3300000000",
        "element-type": "phone"
      },
      "birthday": {
        "status": "COMPLETED",
        "uuid": "9ce4c8fb-3c39-4e42-bc81-45a78760d8ff",
        "value": "1993-01-01T00:00:00",
        "element-type": "birthday"
      },
      "login": null,
      "bo_user_uuid": null
    },
    "activity_sector": {
      "name": "Hotels & holiday rentals"
    },
    "data": {
      "type": "PARTICULAR",
      "company_name": null,
      "history": [],
      "turnover": {
        "name": "Less than 20k EUR"
      },
      "activity_age": null
    },
    "custom_reference": null,
    "is_converted": false,
    "conformity_status": "ON_GOING",
    "conformity_status_level_two": null,
    "comments_level_two": null,
    "validator_level_one": null,
    "validator_level_two": null,
    "merchant_uuid": null,
    "validation_date": null,
    "validation_date_level_two": null,
    "sub_type": null,
    "api_infogreffe_attempt": 0,
    "next_step": 0,
    "full_kyc": false
  },
  "requestId": "e2324dd3-59e4-44e2-a0d7-fe7df9c4a690"
}

ONBOARDING_ENROLLMENT_INVALID_DOCUMENTS
Some documents are regarded as invalid by the Centralpay conformity

ONBOARDING_ENROLLMENT_VALID_DOCUMENTS
Some documents are regarded as valid by the Centralpay conformity

ONBOARDING_PAYMENT_ACCOUNT_CREATED
The account has been created.

{
  "eventId": "69d19eb6-5b4d-4658-8149-526d779328a4",
  "type": "ONBOARDING_PAYMENT_ACCOUNT_CREATED",
  "creationDate": "2024-01-10T09:17:04.318216+01:00",
  "object": {
    "merchantEnrollmentId": "c2e03650-2427-4c25-aa31-016c63f7261b",
    "merchantEnrollmentCustomReference": null,
    "merchantEnrollmentType": "BASIC",
    "merchantId": "cac4f315-4dbf-45da-bb3c-4c9b64fe81c1",
    "merchantName": "Carmelo Littel",
    "merchantWalletId": "9a8fc3a1-bece-4ef2-a92a-d6341f8799e0",
    "creationDate": "2024-01-10T09:17:03+0100",
    "merchantBlockConfigurationStatus": "NONE"
  },
  "requestId": "abd91f96-78c3-4277-8eea-b2a4e323efd3"
}

ONBOARDING_PAYMENT_ACCOUNT_UPDATED
The account has been update. You receive those elements

ONBOARDING_ADDITIONAL_DOCUMENT_REQUESTED
Additionnal documents or information have been request on one ongoing onboarding.

    {
        "uuid": "1ad91002-fcad-4056-a41f-82ab63687af2",
        "additional_documents": 
      {
            "uuid": "eb0b568a-a619-4d80-b35a-846144ef1925",
            "created_at": "2021-03-23T17:30:35+01:00",
            "type": "AUDITED_FINANCIAL_REPORT",
            "additional_documents_history": 
          [
                {
                    "uuid": "1a330b31-9150-45cd-9fc3-bb3bed751b7b",
                    "created_at": "2021-03-23T17:30:35+01:00",
                    "status": "NOT_UPLOADED",
                    "comment": "en couleur de moins de 3 mois",
                    "additional_document_history_status": 
                    [
                        {
                            "changed_at": "2021-03-23T17:30:35+01:00",
                            "value": "NOT_UPLOADED"
                        }
                    ]
                }
            ]
        }
    }

ONBOARDING_ADDITIONAL_DOCUMENT_UPDATED
Additionnal documents or information have been provided by the account holder in one ongoing onboarding.

ONBOARDING_ENROLLMENT_WORKFLOW_RESET
The workflow has returned to it’s initial state

{
  "eventId": "4fa7e538-9e45-4ba2-8c22-25bdb931ff19",
  "type": "ONBOARDING_ENROLLMENT_WORKFLOW_RESET",
  "creationDate": "2024-01-25T12:24:32.450115+01:00",
  "object": {
    "workflow": {
      "uuid": "cc91fb6c-55c0-48b3-82de-549d1061edf9",
      "status": "ON_GOING",
      "activities": [
        {
          "step_elements": [],
          "uuid": "49ff33c2-d4e8-4eec-ad1c-43ebe822706b",
          "name": "ContractValiA",
          "state": "TODO",
          "category": "validation",
          "created_at": "2024-01-25T12:24:32"
        },
        {
          "step_elements": [],
          "uuid": "49ff33c2-d4e8-4eec-ad1c-43ebe822706b",
          "name": "ContractValiA",
          "state": "TODO",
          "category": "validation",
          "created_at": "2024-01-25T12:24:32"
        }
      ],
      "additional_documents": []
    },
    "identity_badge": null,
    "representatives_list": null,
    "inactive_representatives_list": [],
    "infogreffe_identity": null,
    "language": "fr",
    "risk_score": {
      "activity": 2,
      "activity_age": null,
      "turnover": 1,
      "bank_account": 0,
      "total": null
    },
    "additional_document_need_upload": false,
    "uuid": "b7fa53f5-1cc7-4524-8a41-364b6e85f6b4",
    "risk_points": null,
    "created_at": "2024-01-25T12:21:11",
    "last_updated_at": null,
    "turnover_is_fixed": false,
    "workflow_mode": "SEQUENTIAL",
    "risk_level": "LOW",
    "type": "INDIVIDUAL",
    "is_canceled": false,
    "enrollment_account": null,
    "profile": {
      "birthname": {
        "status": "ON_GOING",
        "uuid": "a404d8cf-d4f5-412a-b0a2-fc8843fbe7ed",
        "value": null,
        "element-type": "birthname"
      },
      "uuid": "c8e69bcf-cd2a-4dd5-85a6-252ba8ef2fa2",
      "workflow": {
        "uuid": "512c94e7-f470-446f-b030-65729b681d41",
        "status": "ON_GOING",
        "activities": [
          {
            "step_elements": [
              {
                "status": "COMPLETED",
                "uuid": "e3832733-a07c-4f29-999a-945854cae097",
                "value": "Alejandra",
                "element-type": "firstname"
              },
              {
                "status": "COMPLETED",
                "uuid": "6f2bf419-ada4-4967-b6ff-4c02dee109f4",
                "value": "Walter",
                "element-type": "lastname"
              },
              {
                "status": "COMPLETED",
                "uuid": "a691c5d5-a62a-4cd9-97b1-b68c1e612d0f",
                "value": "+3300000000",
                "element-type": "phone"
              },
              {
                "status": "COMPLETED",
                "uuid": "e077ba27-5cfe-4a5b-ada9-cbf043d50cb5",
                "value": "Tours",
                "element-type": "place-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "faec075e-d17c-4c7d-ad2d-8e9ee573f840",
                "value": "1993-01-01T00:00:00",
                "element-type": "birthday"
              },
              {
                "status": "COMPLETED",
                "uuid": "d052f4da-c670-4075-8d29-d55fdae732a5",
                "country": "FRA",
                "element-type": "country-of-birth"
              },
              {
                "status": "COMPLETED",
                "uuid": "96693dd5-4463-402a-aea7-e034b414825a",
                "value": "tessie_ebert@gmail.com",
                "element-type": "email"
              }
            ],
            "uuid": "b77d7bf7-ab6f-4cb0-ad18-22ac66a50a3b",
            "name": "identityInfos",
            "state": "TODO",
            "category": "identity",
            "created_at": "2024-01-25T12:21:11"
          }
        ],
        "additional_documents": []
      },
      "firstname": {
        "status": "COMPLETED",
        "uuid": "e3832733-a07c-4f29-999a-945854cae097",
        "value": "Alejandra",
        "element-type": "firstname"
      },
      "lastname": {
        "status": "COMPLETED",
        "uuid": "6f2bf419-ada4-4967-b6ff-4c02dee109f4",
        "value": "Walter",
        "element-type": "lastname"
      },
      "usename": {
        "status": "ON_GOING",
        "uuid": "a404d8cf-d4f5-412a-b0a2-fc8843fbe7ed",
        "value": null,
        "element-type": "birthname"
      },
      "email": {
        "status": "COMPLETED",
        "uuid": "96693dd5-4463-402a-aea7-e034b414825a",
        "value": "tessie_ebert@gmail.com",
        "element-type": "email"
      },
      "language": {
        "status": "ON_GOING",
        "uuid": "232259eb-02cf-48af-9693-d678fecd9dc1",
        "locale": {
          "identifier": "fr"
        },
        "element-type": "language"
      },
      "phone": {
        "status": "COMPLETED",
        "uuid": "a691c5d5-a62a-4cd9-97b1-b68c1e612d0f",
        "value": "+3300000000",
        "element-type": "phone"
      },
      "birthday": {
        "status": "COMPLETED",
        "uuid": "faec075e-d17c-4c7d-ad2d-8e9ee573f840",
        "value": "1993-01-01T00:00:00",
        "element-type": "birthday"
      },
      "login": null,
      "bo_user_uuid": null
    },
    "activity_sector": {
      "name": "Artisans (plumber, electricians, ...)"
    },
    "data": {
      "type": "PARTICULAR",
      "company_name": null,
      "history": [],
      "turnover": {
        "name": "Less than 20k EUR"
      },
      "activity_age": null
    },
    "custom_reference": null,
    "is_converted": false,
    "conformity_status": "ON_GOING",
    "conformity_status_level_two": null,
    "comments_level_two": null,
    "validator_level_one": null,
    "validator_level_two": null,
    "merchant_uuid": null,
    "validation_date": null,
    "validation_date_level_two": null,
    "sub_type": null,
    "api_infogreffe_attempt": 0,
    "next_step": 0,
    "full_kyc": false,
    "auto_updated_data": false
  },
  "requestId": "3ca496d0-bd87-4457-8460-fc1e502d4962"
}

ONBOARDING_PEP_SANCTION_SEARCH_RESULT
The PEP Sanction search has return result, you receive those elements

{
  "eventId": "a427366c-eb0b-4d68-9d81-22f406162024",
  "type": "ONBOARDING_PEP_SANCTION_SEARCH_RESULT",
  "creationDate": "2024-01-10T09:16:09.771127+01:00",
  "object": {
    "enrollment_uuid": "c2e03650-2427-4c25-aa31-016c63f7261b",
    "enrollment_url": "https://test-backoffice.centralpay.net/admin/onboarding/c2e03650-2427-4c25-aa31-016c63f7261b/show",
    "profile": {
      "pep_validation": {
        "created_at": "2024-01-10 09:16:04",
        "status": "ACCEPTED",
        "reference": "1704874567-MMSug5fh",
        "client_ref": "225cab33-3c8d-4bc7-b6d8-7f7d7448b49d",
        "review_url": "https://api.complyadvantage.com1704874567-MMSug5fh"
      },
      "sanction_validation": {
        "created_at": "2024-01-10 09:16:04",
        "status": "ACCEPTED",
        "reference": "1704874567-MMSug5fh",
        "client_ref": "225cab33-3c8d-4bc7-b6d8-7f7d7448b49d",
        "review_url": "https://api.complyadvantage.com1704874567-MMSug5fh"
      }
    }
  },
  "requestId": "d995a82d-ff33-4c20-af58-2546f3ef4c09"
}

ENROLLMENT_CREATED
When an enrollement is created

The ONBOARDING object

CONTENU