Receivers
Read a receiver
GET
/
receivers
/
{receiverId}
curl --request GET \
--url https://extensions-sandbox.lumx.io/payments/receivers/{receiverId} \
--header 'Authorization: Bearer <token>'
{
"id": "re_000000000000",
"type": "individual",
"complianceLevel": "standard",
"complianceStatus": "approved",
"firstName": "John",
"lastName": "Doe",
"legalName": "Company Name Inc.",
"taxId": "10210274029",
"email": "email@example.com",
"country": "BR",
"dateOfBirth": "1998-01-01T00:00:00Z",
"dateOfFormation": "1998-01-01T00:00:00Z",
"city": "Marshfield",
"stateProvinceRegion": "MA",
"addressLine1": "738 Plain St",
"addressLine2": "Building 22",
"postalCode": "02050",
"ipAddress": "127.0.0.1",
"idDocumentCountry": "BR",
"idDocumentType": "PASSPORT",
"idDocumentFrontFile": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"idDocumentBackUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"formationDocumentUrl": "https://example.com/image.png",
"proofOfOwnershipDocumentUrl": "https://example.com/image.png",
"shareholders": [
{
"role": "beneficialOwner",
"firstName": "John",
"lastName": "Doe",
"taxId": "123456789",
"country": "US",
"dateOfBirth": "1980-01-01T00:00:00Z",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"stateProvinceRegion": "NY",
"postalCode": "10001",
"idDocumentCountry": "US",
"idDocumentType": "PASSPORT",
"idDocumentFrontUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"idDocumentBackUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://extensions-sandbox.lumx.io/payments/receivers/{receiverId} \
--header 'Authorization: Bearer <token>'
{
"id": "re_000000000000",
"type": "individual",
"complianceLevel": "standard",
"complianceStatus": "approved",
"firstName": "John",
"lastName": "Doe",
"legalName": "Company Name Inc.",
"taxId": "10210274029",
"email": "email@example.com",
"country": "BR",
"dateOfBirth": "1998-01-01T00:00:00Z",
"dateOfFormation": "1998-01-01T00:00:00Z",
"city": "Marshfield",
"stateProvinceRegion": "MA",
"addressLine1": "738 Plain St",
"addressLine2": "Building 22",
"postalCode": "02050",
"ipAddress": "127.0.0.1",
"idDocumentCountry": "BR",
"idDocumentType": "PASSPORT",
"idDocumentFrontFile": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"idDocumentBackUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"formationDocumentUrl": "https://example.com/image.png",
"proofOfOwnershipDocumentUrl": "https://example.com/image.png",
"shareholders": [
{
"role": "beneficialOwner",
"firstName": "John",
"lastName": "Doe",
"taxId": "123456789",
"country": "US",
"dateOfBirth": "1980-01-01T00:00:00Z",
"addressLine1": "123 Main St",
"addressLine2": "Apt 4B",
"city": "New York",
"stateProvinceRegion": "NY",
"postalCode": "10001",
"idDocumentCountry": "US",
"idDocumentType": "PASSPORT",
"idDocumentFrontUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg",
"idDocumentBackUrl": "https://pub-4fabf5dd55154f19a0384b16f2b816d9.r2.dev/v4-460px-Get-Proof-of-Address-Step-3-Version-2.jpg.jpeg"
}
]
}