# /sender Retrieves a sender's full profile by UUID. ## Purpose Returns the complete profile of an existing sender, including personal, contact, address, identification, compliance (KYC) information, and all uploaded identity documents with their review status. ## How It Works 1. Looks up the sender using the provided UUID 2. If `branchId` is provided, the sender is retrieved directly from that branch 3. If `branchId` is omitted, the system automatically searches across all branches associated with your partner account 4. Returns the sender profile including `identityDocuments` — a list of all uploaded ID documents with metadata, image URLs, and review status (APPROVED, NOT REVIEWED, REJECTED) ## Authentication Requires `x-client-id` and `x-secret-key` headers. The partner context is resolved automatically from the authenticated credentials. ## Common Errors - `400` Validation errors (missing/invalid query parameters) - `401` Invalid credentials - `404` Sender not found - `500` Internal error
Error codes (click to expand)
CodeDescription
400001uuid query parameter is required.
401000Invalid credentials. Verify your x-client-id and x-secret-key.
404002Sender not found for the provided uuid.
500000An unexpected error occurred. Please try again later.
Endpoint: GET /sender Version: 1.0.0 ## Query parameters: - `uuid` (string, required) Sender global UUID used to look up the profile. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004 - `branchId` (string) Specific branch to query. If omitted, the branch is resolved automatically across the partner's branches. Error codes: type=400002, minLength=400003, maxLength=400004 ## Header parameters: - `x-client-id` (string, required) Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004 - `x-secret-key` (string, required) Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential. Error codes: required=400001, type=400002, minLength=400003, maxLength=400004 ## Response 200 fields (application/json): - `status` (string) Result status (`success`). - `message` (string) Descriptive message about the operation result. - `data` (object) Sender profile. - `data.uuid` (string) Sender global UUID (alphanumeric). - `data.idSenderGlobal` (number) Numeric global sender identifier. - `data.idSender` (number) Numeric branch-scoped sender identifier. - `data.firstName` (string) Sender's first name. - `data.middleName` (string) Sender's middle name. - `data.lastName` (string) Sender's last name. - `data.secondLastName` (string) Sender's second last name. - `data.phone` (string) Sender's phone number without country code. - `data.phoneCountryCode` (string) International dialing code of the sender's phone. - `data.email` (string) Sender's email address. - `data.dateOfBirth` (string) Sender's date of birth. - `data.addressStreet` (string) Sender's street address. - `data.addressCity` (string) Sender's city. - `data.addressState` (string) Sender's state (ISO 2). - `data.addressCountry` (string) Sender's country (ISO 3166-1 alpha-3). - `data.addressZipCode` (string) Sender's ZIP code. - `data.documentType` (string) Identification document type code. See Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications - `data.documentDescription` (string) Human-readable identification document description. - `data.documentNumber` (string) Identification document number. - `data.documentExpirationDate` (string) Identification document expiration date (format: YYYY-MM-DD). - `data.documentState` (string) State that issued the identification document (ISO 3166-2). - `data.documentCountry` (string) Country that issued the identification document (ISO 3166-1 alpha-3). - `data.occupation` (string) Sender's occupation. Refers to the job name from the selected industry. See [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) - `data.employer` (string) Sender's employer name. - `data.employerPhone` (string) Sender's employer phone number. - `data.proofOfIncome` (string) Sender's source of income or supporting documentation. - `data.ssnNumber` (string) Sender's Social Security Number (U.S.). 9-digit number. - `data.industry` (number) Industry classification identifier. See [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) - `data.job` (number) Job/occupation identifier within the selected industry. See [Catalogs Endpoint Industry](/apis/outbound/catalogs/paths/~1catalogs~1industry/get) - `data.nationality` (string) Sender's nationality country (ISO 3166-1 alpha-3). https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 - `data.currentBranch` (string) Branch associated with the sender. - `data.identityDocuments` (array) List of identity documents uploaded and associated with the sender. Each item contains document metadata, image references, and review status. - `data.identityDocuments.documentType` (string) Identification document type code (e.g., DL, CC, PP). See Catalogs Endpoint Identifications: GET /catalogs/countries/{deliveryCountryISO}/identifications - `data.identityDocuments.documentTypeName` (string) Human-readable name of the identification document type (e.g., DRIVER'S LICENSE, CEDULA CIUDADANIA). - `data.identityDocuments.documentNumber` (string) Identification document number. - `data.identityDocuments.documentState` (string) State or province that issued the document (ISO 3166-2). Empty string if not applicable. - `data.identityDocuments.documentCountry` (string) Country that issued the document (ISO 3166-1 alpha-3). - `data.identityDocuments.expirationDate` (string) Document expiration date (format: YYYY-MM-DD HH:MM:SS). Value '1900-01-01 00:00:00' indicates no expiration set. - `data.identityDocuments.dateInserted` (string) Timestamp when the document was uploaded/registered (format: YYYY-MM-DD HH:MM:SS). - `data.identityDocuments.frontImageName` (string) Filename of the front-side document image stored in S3. - `data.identityDocuments.frontImagePath` (string) Full S3 URL to the front-side document image. - `data.identityDocuments.backImageName` (string) Filename of the back-side document image stored in S3. May be empty if back image was not uploaded. - `data.identityDocuments.backImagePath` (string) Full S3 URL to the back-side document image. May be empty if back image was not uploaded. - `data.identityDocuments.reviewStatus` (string) Human-readable review status of the document (e.g., NOT REVIEWED, APPROVED, REJECTED). - `data.identityDocuments.reviewStatusId` (number) Numeric identifier of the review status (0 = NOT REVIEWED, 1 = APPROVED, 2 = REJECTED). - `data.identityDocuments.rejectionCode` (string | null) Code indicating the reason for rejection. Null if not rejected. - `data.identityDocuments.rejectionReason` (string) Descriptive reason for document rejection. Empty string if not rejected. ## Response 400 fields (application/json): - `errors` (array) List of validation errors.Error catalog for 400 (click to expand)CodeDescription400001uuid query parameter is required. - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) - `errors.details` (string) ## Response 401 fields (application/json): - `errors` (array) List of authentication errors.Error catalog for 401 (click to expand)CodeDescription401000Invalid credentials. Verify your x-client-id and x-secret-key. - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) ## Response 404 fields (application/json): - `errors` (array) List of not-found errors.Error catalog for 404 (click to expand)CodeDescription404002Sender not found for the provided uuid. - `errors.status` (string) - `errors.code` (number) - `errors.message` (string) ## Response 500 fields (application/json): - `errors` (array) List of internal errors.Error catalog for 500 (click to expand)CodeDescription500000An unexpected error occurred. Please try again later. - `errors.status` (string) - `errors.code` (number) - `errors.message` (string)