Provider notification generated

Notification from the provider regarding the creation process of a new prospect account

Type: object
Domain: banking-prospect
Event: provider_notification
Version: 1

|
id required

Title: Banking prospect provisioning unique identifier
Description: An ID assigned to new prospect creation
Type: string
Example:
12387965::TN-d6fe9b36-6a14-432e-b177

provider required

Title: Provider
Description: Provider's Name
Type: string
Example:
Celcoin

client_document_number required

Title: Client Document Number
Description: Document number that associates the customer with the creation of a new prospect account
Type: string
Example:
123456789

status required

Title: Status
Description: Provider's status
Type: string
Example:
REJECTED
APPROVED

step required

Title: Step
Description: Provider's step
Type: string
Example:
PROVIDER_BACKGROUND_CHECK

custom_fields required

Title: Custom Fields
Description: Custom fields
Type: object
Additional properties: {'type': 'string'}
Example:
{'action_required': 'validate customer data'}
{'message': 'The onboarding process is at step: PROVIDER_BACKGROUND_CHECK', 'status': 'PENDING'}

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Provider notification generated",
    "description": "Notification from the provider regarding the creation process of a new prospect account",
    "required": [
        "id",
        "provider",
        "client_document_number",
        "status",
        "step",
        "custom_fields"
    ],
    "properties": {
        "id": {
            "type": "string",
            "title": "Banking prospect provisioning unique identifier",
            "description": "An ID assigned to new prospect creation ",
            "examples": [
                "12387965::TN-d6fe9b36-6a14-432e-b177"
            ]
        },
        "provider": {
            "type": "string",
            "title": "Provider",
            "description": "Provider's Name",
            "examples": [
                "Celcoin"
            ]
        },
        "client_document_number": {
            "type": "string",
            "title": "Client Document Number",
            "description": "Document number that associates the customer with the creation of a new prospect account",
            "examples": [
                "123456789"
            ]
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Provider's status",
            "examples": [
                "REJECTED",
                "APPROVED"
            ]
        },
        "step": {
            "type": "string",
            "title": "Step",
            "description": "Provider's step",
            "examples": [
                "PROVIDER_BACKGROUND_CHECK"
            ]
        },
        "custom_fields": {
            "type": "object",
            "additionalProperties": {
                "type": "string"
            },
            "title": "Custom Fields",
            "description": "Custom fields",
            "examples": [
                {
                    "action_required": "validate customer data"
                },
                {
                    "message": "The onboarding process is at step: PROVIDER_BACKGROUND_CHECK",
                    "status": "PENDING"
                }
            ]
        }
    }
}
{
    "id": "12387965::TN-d6fe9b36-6a14-432e-b177",
    "provider": "Celcoin",
    "client_document_number": "123456789",
    "status": "REJECTED",
    "step": "PROVIDER_BACKGROUND_CHECK",
    "custom_fields": {
        "action_required": "validate customer data"
    }
}