Create Merchant - BlancBlock OpenAPI

Create a new merchant with KYC application

Request

Authorization

API Key

Add parameter in header

x-signature

Example:

x-signature: ********************

Header Params

Body Params application/json

Example

{
    "merchantType": "INDIVIDUAL",
    "profile": {
        "legalName": "string",
        "registeredCountry": "string",
        "businessEmail": "user@example.com",
        "businessPhone": "string"
    },
    "kycApplication": {
        "applicationType": "KYB_CORPORATE",
        "companyInfo": {
            "legalName": "string",
            "registrationCountry": "string",
            "tradingName": "string",
            "registrationNumber": "string",
            "registrationAddress": "string",
            "registrationDate": "2019-08-24",
            "industry": "string",
            "businessDescription": "string",
            "expectedMonthlyVolume": "string",
            "websiteUrl": "http://example.com"
        },
        "documents": {
            "businessLicense": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "articlesOfIncorporation": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "conditionalDocuments": {
                "hongKong": {
                    "brCertificate": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    },
                    "nnc1OrNar1": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z",
                        "documentType": "NNC1"
                    }
                }
            },
            "capitalStructureDiagram": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "enterpriseAddressProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            }
        },
        "fundingInfo": {
            "sourceOfFunds": "string",
            "sourceOfFundsProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "purposeOfFunds": "string",
            "purposeOfFundsProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            }
        },
        "beneficialOwners": [
            {
                "role": "string",
                "isDirector": true,
                "personalInfo": {
                    "firstName": "string",
                    "lastName": "string",
                    "nationality": "string",
                    "gender": "MALE",
                    "dateOfBirth": "2019-08-24"
                },
                "identification": {
                    "documentType": "PASSPORT",
                    "documentNumber": "string",
                    "issuedDate": "2019-08-24",
                    "expiryDate": "2019-08-24",
                    "documentFiles": [
                        {
                            "fileUrl": "http://example.com",
                            "fileName": "string",
                            "uploadTime": "2019-08-24T14:15:22.123Z"
                        }
                    ],
                    "selfieWithDocument": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "residenceInfo": {
                    "residenceCountry": "string",
                    "residenceAddress": "string",
                    "addressProof": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "ownershipInfo": {
                    "sharePercentage": 0,
                    "shareRegister": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                }
            }
        ],
        "directors": [
            {
                "personalInfo": {
                    "firstName": "string",
                    "lastName": "string",
                    "nationality": "string",
                    "gender": "MALE",
                    "dateOfBirth": "2019-08-24"
                },
                "identification": {
                    "documentType": "PASSPORT",
                    "documentNumber": "string",
                    "issuedDate": "2019-08-24",
                    "expiryDate": "2019-08-24",
                    "documentFiles": [
                        {
                            "fileUrl": "http://example.com",
                            "fileName": "string",
                            "uploadTime": "2019-08-24T14:15:22.123Z"
                        }
                    ],
                    "selfieWithDocument": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "residenceInfo": {
                    "residenceCountry": "string",
                    "residenceAddress": "string",
                    "addressProof": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "isFromBeneficialOwner": true
            }
        ],
        "submissionInfo": {
            "submittedAt": "2019-08-24T14:15:22.123Z",
            "submissionStatus": "DRAFT"
        },
        "tag": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/merchants' \
--header 'x-app-id;' \
--header 'x-timestamp;' \
--header 'x-nonce;' \
--header 'x-request-id;' \
--header 'x-lang;' \
--header 'x-signature: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantType": "INDIVIDUAL",
    "profile": {
        "legalName": "string",
        "registeredCountry": "string",
        "businessEmail": "user@example.com",
        "businessPhone": "string"
    },
    "kycApplication": {
        "applicationType": "KYB_CORPORATE",
        "companyInfo": {
            "legalName": "string",
            "registrationCountry": "string",
            "tradingName": "string",
            "registrationNumber": "string",
            "registrationAddress": "string",
            "registrationDate": "2019-08-24",
            "industry": "string",
            "businessDescription": "string",
            "expectedMonthlyVolume": "string",
            "websiteUrl": "http://example.com"
        },
        "documents": {
            "businessLicense": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "articlesOfIncorporation": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "conditionalDocuments": {
                "hongKong": {
                    "brCertificate": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    },
                    "nnc1OrNar1": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z",
                        "documentType": "NNC1"
                    }
                }
            },
            "capitalStructureDiagram": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "enterpriseAddressProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            }
        },
        "fundingInfo": {
            "sourceOfFunds": "string",
            "sourceOfFundsProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            },
            "purposeOfFunds": "string",
            "purposeOfFundsProof": {
                "fileUrl": "http://example.com",
                "fileName": "string",
                "uploadTime": "2019-08-24T14:15:22.123Z"
            }
        },
        "beneficialOwners": [
            {
                "role": "string",
                "isDirector": true,
                "personalInfo": {
                    "firstName": "string",
                    "lastName": "string",
                    "nationality": "string",
                    "gender": "MALE",
                    "dateOfBirth": "2019-08-24"
                },
                "identification": {
                    "documentType": "PASSPORT",
                    "documentNumber": "string",
                    "issuedDate": "2019-08-24",
                    "expiryDate": "2019-08-24",
                    "documentFiles": [
                        {
                            "fileUrl": "http://example.com",
                            "fileName": "string",
                            "uploadTime": "2019-08-24T14:15:22.123Z"
                        }
                    ],
                    "selfieWithDocument": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "residenceInfo": {
                    "residenceCountry": "string",
                    "residenceAddress": "string",
                    "addressProof": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "ownershipInfo": {
                    "sharePercentage": 0,
                    "shareRegister": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                }
            }
        ],
        "directors": [
            {
                "personalInfo": {
                    "firstName": "string",
                    "lastName": "string",
                    "nationality": "string",
                    "gender": "MALE",
                    "dateOfBirth": "2019-08-24"
                },
                "identification": {
                    "documentType": "PASSPORT",
                    "documentNumber": "string",
                    "issuedDate": "2019-08-24",
                    "expiryDate": "2019-08-24",
                    "documentFiles": [
                        {
                            "fileUrl": "http://example.com",
                            "fileName": "string",
                            "uploadTime": "2019-08-24T14:15:22.123Z"
                        }
                    ],
                    "selfieWithDocument": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "residenceInfo": {
                    "residenceCountry": "string",
                    "residenceAddress": "string",
                    "addressProof": {
                        "fileUrl": "http://example.com",
                        "fileName": "string",
                        "uploadTime": "2019-08-24T14:15:22.123Z"
                    }
                },
                "isFromBeneficialOwner": true
            }
        ],
        "submissionInfo": {
            "submittedAt": "2019-08-24T14:15:22.123Z",
            "submissionStatus": "DRAFT"
        },
        "tag": "string"
    }
}'

Responses

🟢200OK

application/json

Merchant created successfully

Bodyapplication/json

Example

{
    "success": true,
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22.123Z",
    "data": {
        "merchantId": "string",
        "merchantType": "INDIVIDUAL",
        "status": "UNVERIFIED",
        "kycStatus": "DRAFT",
        "createdAt": "2019-08-24T14:15:22.123Z"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409Conflict

🟠422Unprocessable Entity

🟠429Too Many Requests